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 incarcerated_individuals_under_custody_beginning table in this repository, by referencing it like:
"ny-gov/incarcerated-individuals-under-custody-beginning-55zc-sp6m:latest"."incarcerated_individuals_under_custody_beginning"or in a full query, like:
SELECT
":id", -- Socrata column ID
"current_age", -- Incarcerated individual age as of the file date
"most_serious_crime", -- Most serious conviction offense of incarcerated individual, as defined by offense with the longest maximum sentence Refer to DOCCS Crime List for more detailed crime descriptions and associated legal authority.
"snapshot_year", -- Year represented by the snapshot population. Data represents inmates under custody on March 31, the end of the Fiscal Year.
"gender", -- Incarcerated individual gender
"county_of_indictment", -- County of indictment associated with the most serious conviction offense
"housing_facility", -- Facility in which incarcerated individual was housed as of the file date
"race_ethnicity", -- Race/Ethnicity as reported by the incarcerated individual, adjusted for country of birth and parental country of birth to determine Hispanic ethnicity. Incarcerated individuals with Hispanic ethnicity will be reported as Hispanic, regardless of reported race. This data element is provided for the snapshot of the population as of March 31 (Beginning 2018).
"facility_security_level", -- Security Level associated with incarcerated individual housing facility as of the file date
"latest_admission_type" -- Type of Admission to NYSDOCCS New Court Commitment = new admission to prison on current offense Returned Parole Violator (RPV) = return to prison for technical violation of parole conditions Other = This category represents returns to prison for something other than a new court commitment or a parole violation. It is comprised primarily of returns from other agencies and returns from court ordered discharge.
FROM
"ny-gov/incarcerated-individuals-under-custody-beginning-55zc-sp6m:latest"."incarcerated_individuals_under_custody_beginning"
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 ny-gov/incarcerated-individuals-under-custody-beginning-55zc-sp6m 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 ny-gov/incarcerated-individuals-under-custody-beginning-55zc-sp6m: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 ny-gov/incarcerated-individuals-under-custody-beginning-55zc-sp6mCheckout 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 ny-gov/incarcerated-individuals-under-custody-beginning-55zc-sp6m:latestThis will download all the objects for the latest tag of ny-gov/incarcerated-individuals-under-custody-beginning-55zc-sp6m 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 ny-gov/incarcerated-individuals-under-custody-beginning-55zc-sp6m: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 ny-gov/incarcerated-individuals-under-custody-beginning-55zc-sp6m: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, ny-gov/incarcerated-individuals-under-custody-beginning-55zc-sp6m is just another Postgres schema.