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 list_of_nj_municipalities_and_compliance_with_2007 table in this repository, by referencing it like:
"nj-gov/list-of-nj-municipalities-and-compliance-with-2007-i749-em3c:latest"."list_of_nj_municipalities_and_compliance_with_2007"or in a full query, like:
SELECT
":id", -- Socrata column ID
"over_the_cap", -- When a town pays more than $15,000 for unused sick leave
"other_than_retirement", -- When a town gives sick leave payments when an employee resigns or switches jobs
"address", -- Address of township
"address_2", -- Address of township
"annual_sick_leave", -- When a town has agreed to sick leave payments every year
"county", -- County where township is located
"terminal_leave", -- When a town give employees as much as months' worth of time off before retirement
"geo_code", -- code that locates township on map
"sick_leave_incentive_program", -- When a town gives monetary incentives to employees for unused sick leave
"township", -- Name of town
"vacation_accrual_over_1_year", -- When a town gives employees the ability to roll over more than 1 year of vacation time
"zip_code", -- ZIP code of township
":@computed_region_afba_4m32", -- This column was automatically created in order to record in what polygon from the dataset 'Counties' (afba-4m32) the point in column 'geo_code' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
":@computed_region_n6vm_g4q6", -- This column was automatically created in order to record in what polygon from the dataset 'Zip Codes' (n6vm-g4q6) the point in column 'geo_code' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"state" -- State where township is located
FROM
"nj-gov/list-of-nj-municipalities-and-compliance-with-2007-i749-em3c:latest"."list_of_nj_municipalities_and_compliance_with_2007"
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 nj-gov/list-of-nj-municipalities-and-compliance-with-2007-i749-em3c 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 nj-gov/list-of-nj-municipalities-and-compliance-with-2007-i749-em3c: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 nj-gov/list-of-nj-municipalities-and-compliance-with-2007-i749-em3cCheckout 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 nj-gov/list-of-nj-municipalities-and-compliance-with-2007-i749-em3c:latestThis will download all the objects for the latest tag of nj-gov/list-of-nj-municipalities-and-compliance-with-2007-i749-em3c 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 nj-gov/list-of-nj-municipalities-and-compliance-with-2007-i749-em3c: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 nj-gov/list-of-nj-municipalities-and-compliance-with-2007-i749-em3c: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, nj-gov/list-of-nj-municipalities-and-compliance-with-2007-i749-em3c is just another Postgres schema.