Query the Data Delivery Network
Query the DDNThe easiest way to query any data on Splitgraph is via the "Data Delivery Network" (DDN). The DDN is a single endpoint that speaks the PostgreSQL wire protocol. Any Splitgraph user can connect to it at data.splitgraph.com:5432
and query any version of over 40,000 datasets that are hosted or proxied by Splitgraph.
For example, you can query the transportation_services_index_and
table in this repository, by referencing it like:
"bts-gov/transportation-services-index-and-bw6n-ddqk:latest"."transportation_services_index_and"
or in a full query, like:
SELECT
":id", -- Socrata column ID
"tsi_total_c", -- The monthly change in value of the Transportation Services Combined Index.
"load_factor_d_d11", -- Seasonally-Adjusted Load Factor for U.S. Air Carrier Domestic, Scheduled Passenger Flights (Percent)
"rpm_d", -- Revenue Passenger Miles (RPMs) for U.S. Air Carrier Domestic, Scheduled Passenger Flights (Thousands)
"enplane_d_d11", -- Seasonally-Adjusted Enplanements for U.S. Air Carrier Domestic, Scheduled Passenger Flights (Thousands)
"air_rtmfm", -- Air Revenue Ton Miles Of Freight And Mail (RTMFM) (Ton Miles)
"rail_frt_intermodal_d11", -- Seasonally-Adjusted Rail Freight Intermodal Traffic
"transit_d11", -- Seasonally-Adjusted Public Transit Ridership (Thousands Of Unlinked Trips)
"vmt", -- Vehicle Miles Traveled (VMT)
"tsi_total", -- The Transportation Services Combined Index is a weighted average of monthly data for passenger (passenger aviation, transit, and) passenger rail and freight (trucking, freight rail, waterborne, pipeline, and air freight) transportation modes.
"idx_natural_gas_d11",
"idx_truck_d11",
"asm", -- Available Seat Miles (ASMs) for U.S. Air Carrier Domestic and International, Scheduled Passenger Flights (Thousands)
"asm_i_d11", -- Seasonally-Adjusted Available Seat Miles (ASMs) for U.S. Air Carrier International, Scheduled Passenger Flights (Thousands)
"rpm_i", -- Revenue Passenger Miles (RPMs) for U.S. Air Carrier International, Scheduled Passenger Flights (Thousands)
"load_factor_i_d11", -- Seasonally-Adjusted Load Factor for U.S. Air Carrier International, Scheduled Passenger Flights (Percent)
"enplane_i_d11", -- Seasonally-Adjusted Enplanements for U.S. Air Carrier International, Scheduled Passenger Flights (Thousands)
"enplane_d", -- Enplanements for U.S. Air Carrier Domestic, Scheduled Passenger Flights (Thousands)
"enplane_d11", -- Seasonally-Adjusted Enplanements for U.S. Air Carrier Domestic and International, Scheduled Passenger Flights (Thousands)
"rail_pm", -- Rail Passenger Miles
"natural_gas_d11", -- Seasonally-Adjusted Natural Gas Consumption (Billion Cubic Feet)
"waterborne", -- Tonnage for Internal U.S. Waterways (Millions Of Short Tons)
"truck_d11", -- Seasonally-Adjusted Truck Tonnage (Truck Tonnage Index)
"vmt_d11", -- Seasonally-Adjusted Vehicle Miles Traveled (VMT)
"tsi_freight_c", -- The monthly change in value of the Transportation Services Freight Index.
"idx_petroleum_d11",
"idx_waterborne_d11",
"obs_date", -- Observation Date ( Month and Year)
"enplane_i", -- Enplanements for U.S. Air Carrier International, Scheduled Passenger Flights (Thousands)
"petroleum", -- Pipeline Movement (Thousands Of Barrels)
"petroleum_d11", -- Seasonally-Adjusted Pipeline Movement (Thousands Of Barrels)
"manuf",
"rail_frt_carloads_d11", -- Seasonally-Adjusted Rail Freight Carloads
"id", -- Unique row identifier
"air_rpm_tsi", -- Air Revenue Passenger Miles (RPMs) (Thousands)
"rail_frt_intermodal", -- Rail Freight Intermodal Traffic
"natural_gas", -- Natural Gas Consumption (Billion Cubic Feet)
"load_factor_i", -- Load Factor for U.S. Air Carrier International, Scheduled Passenger Flights (Percent)
"asm_d", -- Available Seat Miles (ASMs) for U.S. Air Carrier Domestic, Scheduled Passenger Flights (Thousands)
"rpm", -- Revenue Passenger Miles (RPMs) for U.S. Air Carrier Domestic and International, Scheduled Passenger Flights (Thousands)
"rpm_d11", -- Seasonally-Adjusted Revenue Passenger Miles (RPMs) for U.S. Air Carrier Domestic and International, Scheduled Passenger Flights (Thousands)
"rpm_d_d11", -- Seasonally-Adjusted Revenue Passenger Miles (RPMs) for U.S. Air Carrier Domestic, Scheduled Passenger Flights (Thousands)
"load_factor_d11", -- Seasonally-Adjusted Load Factor for U.S. Air Carrier Domestic and International, Scheduled Passenger Flights (Thousands)
"enplane", -- Enplanements for U.S. Air Carrier Domestic and International, Scheduled Passenger Flights (Thousands)
"waterborne_d11", -- Seasonally-Adjusted Tonnage for Internal U.S. Waterways (Millions Of Short Tons)
"idx_air_rpm",
"idx_air_rtmfm",
"idx_transit_d11",
"idx_rail_frt_intermodal",
"idx_rail_pm",
"rpm_i_d11", -- Seasonally-Adjusted Revenue Passenger Miles (RPMs) for U.S. Air Carrier International, Scheduled Passenger Flights (Thousands)
"asm_d11", -- Seasonally-Adjusted Available Seat Miles (ASMs) for U.S. Air Carrier Domestic and International, Scheduled Passenger Flights (Thousands)
"asm_d_d11", -- Seasonally-Adjusted Available Seat Miles (ASMs) for U.S. Air Carrier Domestic, Scheduled Passenger Flights (Thousands)
"asm_i", -- Available Seat Miles (ASMs) for U.S. Air Carrier International, Scheduled Passenger Flights (Thousands)
"load_factor", -- Load Factor for U.S. Air Carrier Domestic and International, Scheduled Passenger Flights (Thousands)
"load_factor_d", -- Load Factor for U.S. Air Carrier Domestic, Scheduled Passenger Flights (Percent)
"air_rpm_tsi_d11", -- Seasonally-Adjusted Air Revenue Passenger Miles (RPMs) (Thousands)
"air_rtmfm_d11", -- Seasonally-Adjusted Air Revenue Ton Miles Of Freight And Mail (RTMFM) (Ton Miles)
"rail_frt_carloads", -- Rail Freight Carloads
"rail_pm_d11", -- Seasonally-Adjusted Rail Passenger Miles
"transit", -- Public Transit Ridership (Thousands Of Unlinked Trips)
"tsi_freight", -- The Transportation Services Freight Index is a weighted average of monthly data for trucking, freight rail, waterborne, pipeline, and air freight.
"tsi_passenger", -- The Transportation Services Passenger Index is a weighted average of monthly data for passenger aviation, transit, and passenger rail.
"tsi_passenger_c", -- The monthly change in value of the Transportation Services Passenger Index.
"ind_pro",
"inv_to_sales",
"idx_rail_frt_carloads"
FROM
"bts-gov/transportation-services-index-and-bw6n-ddqk:latest"."transportation_services_index_and"
LIMIT 100;
Connecting to the DDN is easy. All you need is an existing SQL client that can connect to Postgres. As long as you have a SQL client ready, you'll be able to query bts-gov/transportation-services-index-and-bw6n-ddqk
with SQL in under 60 seconds.
Query Your Local Engine
bash -c "$(curl -sL https://github.com/splitgraph/splitgraph/releases/latest/download/install.sh)"
Read the installation docs.
Splitgraph Cloud is built around Splitgraph Core (GitHub), which includes a local Splitgraph Engine packaged as a Docker image. Splitgraph Cloud is basically a scaled-up version of that local Engine. When you query the Data Delivery Network or the REST API, we mount the relevant datasets in an Engine on our servers and execute your query on it.
It's possible to run this engine locally. You'll need a Mac, Windows or Linux system to install sgr
, and a Docker installation to run the engine. You don't need to know how to actually use Docker; sgr
can manage the image, container and volume for you.
There are a few ways to ingest data into the local engine.
For external repositories, the Splitgraph Engine can "mount" upstream data sources by using sgr mount
. This feature is built around Postgres Foreign Data Wrappers (FDW). You can write custom "mount handlers" for any upstream data source. For an example, we blogged about making a custom mount handler for HackerNews stories.
For hosted datasets (like this repository), where the author has pushed Splitgraph Images to the repository, you can "clone" and/or "checkout" the data using sgr clone
and sgr checkout
.
Cloning Data
Because bts-gov/transportation-services-index-and-bw6n-ddqk:latest
is a Splitgraph Image, you can clone the data from Spltgraph Cloud to your local engine, where you can query it like any other Postgres database, using any of your existing tools.
First, install Splitgraph if you haven't already.
Clone the metadata with sgr clone
This will be quick, and does not download the actual data.
sgr clone bts-gov/transportation-services-index-and-bw6n-ddqk
Checkout the data
Once you've cloned the data, you need to "checkout" the tag that you want. For example, to checkout the latest
tag:
sgr checkout bts-gov/transportation-services-index-and-bw6n-ddqk:latest
This will download all the objects for the latest
tag of bts-gov/transportation-services-index-and-bw6n-ddqk
and load them into the Splitgraph Engine. Depending on your connection speed and the size of the data, you will need to wait for the checkout to complete. Once it's complete, you will be able to query the data like you would any other Postgres database.
Alternatively, use "layered checkout" to avoid downloading all the data
The data in bts-gov/transportation-services-index-and-bw6n-ddqk:latest
is 0 bytes. If this is too big to download all at once, or perhaps you only need to query a subset of it, you can use a layered checkout.:
sgr checkout --layered bts-gov/transportation-services-index-and-bw6n-ddqk:latest
This will not download all the data, but it will create a schema comprised of foreign tables, that you can query as you would any other data. Splitgraph will lazily download the required objects as you query the data. In some cases, this might be faster or more efficient than a regular checkout.
Read the layered querying documentation to learn about when and why you might want to use layered queries.
Query the data with your existing tools
Once you've loaded the data into your local Splitgraph Engine, you can query it with any of your existing tools. As far as they're concerned, bts-gov/transportation-services-index-and-bw6n-ddqk
is just another Postgres schema.