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 ets_gtfs_feed_trip_schedule
table in this repository, by referencing it like:
"edmonton-ca/ets-gtfs-feed-trip-schedule-4fvt-p2se:latest"."ets_gtfs_feed_trip_schedule"
or in a full query, like:
SELECT
":id", -- Socrata column ID
"departure_time_fixed", -- For times occurring after midnight on the service day, times have values greater than 24:00:00; this column represents such times normally (i.e. for hours >= 24, 24 is subtracted)
"arrival_time_fixed", -- For times occurring after midnight on the service day, times have values greater than 24:00:00; this column represents such times normally (i.e. for hours >= 24, 24 is subtracted)
"departure_time", -- [stop_times.txt] Departure time from a specific stop for a specific trip on a route. For times occurring after midnight on the service day, times have values greater than 24:00:00.
"arrival_time", -- [stop_times.txt] Arrival time at a specific stop for a specific trip on a route. For times occurring after midnight on the service day, times have values greater than 24:00:00.
"stop_sequence", -- [stop_times.txt] Order of stops for a particular trip. The values must increase along the trip but do not need to be consecutive.
"stop_name", -- [stops.txt] Name of the location.
"route_long_name", -- [routes.txt] Full name of a route.
"trip_headsign", -- [trips.txt] Text that appears on signage identifying the trip's destination to riders.
"route_type_descr", -- [routes.txt] Indicates the type of transportation used on a route (description).
"trip_id", -- [trips.txt] Identifies a trip.
"stop_id", -- [stops.txt] Identifies a stop, station, or station entrance.
"feed_end_date", -- [feed_info.txt] The dataset provides complete and reliable schedule information for service in the period from the beginning of the feed_start_date day to the end of the feed_end_date day
"wheelchair_accessible", -- [trips.txt] Indicates wheelchair accessibility.
"service_id", -- [trips.txt] ID referencing calendar.service_id or calendar_dates.service_id, which identifies a set of dates when service is available for one or more routes (calendar data is not included in this particular dataset, but this attribute facilitates joining).
"route_id", -- [trips.txt] Identifies a route.
"bikes_allowed", -- [trips.txt] Indicates whether bikes are allowed.
"agency_name", -- [agency.txt] Full name of the transit agency.
"feed_start_date", -- [feed_info.txt] The dataset provides complete and reliable schedule information for service in the period from the beginning of the feed_start_date day to the end of the feed_end_date day
"route_type", -- [routes.txt] Indicates the type of transportation used on a route.
"feed_version" -- [feed_info.txt] String that indicates the current version of their GTFS dataset. GTFS-consuming applications can display this value to help dataset publishers determine whether the latest dataset has been incorporated.
FROM
"edmonton-ca/ets-gtfs-feed-trip-schedule-4fvt-p2se:latest"."ets_gtfs_feed_trip_schedule"
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 edmonton-ca/ets-gtfs-feed-trip-schedule-4fvt-p2se
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 edmonton-ca/ets-gtfs-feed-trip-schedule-4fvt-p2se: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 edmonton-ca/ets-gtfs-feed-trip-schedule-4fvt-p2se
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 edmonton-ca/ets-gtfs-feed-trip-schedule-4fvt-p2se:latest
This will download all the objects for the latest
tag of edmonton-ca/ets-gtfs-feed-trip-schedule-4fvt-p2se
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 edmonton-ca/ets-gtfs-feed-trip-schedule-4fvt-p2se: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 edmonton-ca/ets-gtfs-feed-trip-schedule-4fvt-p2se: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, edmonton-ca/ets-gtfs-feed-trip-schedule-4fvt-p2se
is just another Postgres schema.