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 bikeshare_docked_and_dockless_and_escooter_systems table in this repository, by referencing it like:
"bts-gov/bikeshare-docked-and-dockless-and-escooter-systems-cqdc-cm7d:latest"."bikeshare_docked_and_dockless_and_escooter_systems"or in a full query, like:
SELECT
":id", -- Socrata column ID
"lon", -- Approximate longitude for primary city served by system(s)
":@computed_region_wbq9_i9bc", -- This column was automatically created in order to record in what polygon from the dataset 'US Counties' (wbq9-i9bc) the point in column 'the_geom' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
":@computed_region_nw2e_u85y", -- This column was automatically created in order to record in what polygon from the dataset 'US States and Territories' (nw2e-u85y) the point in column 'the_geom' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"the_geom",
"placeid", -- Identifier unique to city (area) served
"yearplaceid", -- Identifier unique to city (area) served and year
"city", -- City (area) served by system(s). Some systems serve more than one city. Record lists just the primary city served.
"state", -- State of city (area) served by system(s)
"citystate", -- City (area) and state name served by system(s)
"year", -- Year of record
"asofdate", -- As of date for count and name of system(s) serving city (area)
"dockid", -- Unique identifier for docked bikeshare system serving city (area) if applicable
"dockct", -- Count of docked bikeshare stations
"stationct_pct", -- number of docked bikeshare stations as percent of total docked bikeshare stations across all systems for the year (value 0 to 100)
"stationct_bin", -- stationCt_pct grouped into following categories: if stationCt_pct < 1% then 1, if 1%<=stationCt_pct<3% then 2, if 3%<=stationCt_pct<5% then 3, if stationCt_pct>=5% then 4
"docknm", -- Name of docked bikeshare system
"docklessct", -- Count of dockless bikeshare system(s) serving city (area)
"dockless_bin", -- docklessCt grouped into following categories: if docklessCt < 1% then 1, if 1%<=docklessCt<2% then 2, if 2%<=docklessCt<3% then 3, if docklessCt>=3% then 4
"docklessnm", -- Name of dockless bikeshare system(s) serving city (area)
"scooterct", -- Count of e-scooter system(s) serving city (area)
"scooter_bin", -- scooterCt grouped into following categories: if scooterCt < 1% then 1, if 1%<=scooterCt<2% then 2, if 2%<=scooterCt<3% then 3, if scooterCt>=3% then 4
"scooternm", -- Name of e-scooter system(s) serving city (area)
"type", -- Types of system(s) serving city (area)
"lat", -- Approximate latitude for primary city served by system(s)
"fips", -- State and county FIPS identifier
"datedocklaunch", -- Date docked bikeshare system launched
"datedockclosed", -- Date docked bikeshare system closed, if applicable
"datescooterlaunch", -- Date e-scooter system launched in city.
"datescooterend", -- Date e-scooter system left city and/or permit by the city expired.
"datedocklesslaunch", -- Date dockless bikeshare system launched in city.
"datedocklessend", -- Date dockless bikeshare system left city and/or permit with city expired.
"docknotes", -- Notes for docked bikeshare system(s)
"notesdockless", -- Notes for dockless bikeshare system(s)
"notesscooter", -- Notes about e-scooter systems(s)
"scooterct_jul", -- Count of scooter systems operating as of June 30th in year.
"dockct_jul", -- Count of docked bikeshare systems operating as of June 30th in year.
"docklessnm_jul", -- Name of dockless bikeshare systems operating as of June 30th in year.
"scooternm_jul", -- Name of e-scooter systems operating as of June 30th in year.
"docknm_jul", -- Name of docked bikeshare system(s) operating as of June 30th in year.
"docklessct_jul" -- Count of dockless bikeshare systems operating as of June 30th in year.
FROM
"bts-gov/bikeshare-docked-and-dockless-and-escooter-systems-cqdc-cm7d:latest"."bikeshare_docked_and_dockless_and_escooter_systems"
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/bikeshare-docked-and-dockless-and-escooter-systems-cqdc-cm7d 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; sgrcan 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 cloneand sgr checkout.
Cloning Data
Because bts-gov/bikeshare-docked-and-dockless-and-escooter-systems-cqdc-cm7d: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/bikeshare-docked-and-dockless-and-escooter-systems-cqdc-cm7dCheckout 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/bikeshare-docked-and-dockless-and-escooter-systems-cqdc-cm7d:latestThis will download all the objects for the latest tag of bts-gov/bikeshare-docked-and-dockless-and-escooter-systems-cqdc-cm7d 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/bikeshare-docked-and-dockless-and-escooter-systems-cqdc-cm7d: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/bikeshare-docked-and-dockless-and-escooter-systems-cqdc-cm7d:latestThis 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/bikeshare-docked-and-dockless-and-escooter-systems-cqdc-cm7d is just another Postgres schema.