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 current_iowa_correctional_system_prison_population table in this repository, by referencing it like:
"mydata-iowa-gov/current-iowa-correctional-system-prison-population-xbcv-c6t2:latest"."current_iowa_correctional_system_prison_population"or in a full query, like:
SELECT
":id", -- Socrata column ID
"race_ethnicity", -- Race and ethnicity of the offender
"offense_type", -- The offense type of the most serious offense the offender was convicted of
"offense_description", -- The description of the most serious offense the offender was convicted of
"months_served", -- Time served by the offender in months
"offense_subtype", -- The offense subtype of the most serious offense the offender was convicted of
"age", -- Age of the offender as of the report date
"education", -- Highest level of education on file for the offender. Education information can be derived from a number of resources, and is not restricted based on the level of verification.
"education_category", -- Categorizes education completed by offender into three categories: Post-Secondary, HS Diploma or Equivalent, and No HS Diploma. Post-Secondary includes the following: In College, Freshman level college, Sophomore level college, Junior level college, Vocational/Technical Student, Technical Training Completion, Vocational Program/Technical Certificate, Associate's Degree, Bachelor's Degree, Master's Degree, and Doctorate. HS Diploma or Equivalent includes the following: High School Diploma, HiSET/GED and Special Education Diploma. No HS Diploma includes: First through Twelfth, No Diploma/No Certificate, Now Attending, and Unknown.
"supervising_intitution", -- Name of the institution supervising the offender is first at
"prison_admit_type", -- The prison admission type for the offender
"prison_start_date", -- The date when prison started for the offender
"record_id", -- Unique number assigned to each record
"offense_code", -- The code found in Iowa law book for most serious crime the offender was convicted of
"sex", -- Sex of the offender
"offense_class", -- The classification of the most serious offense the offender was convicted of
"offender_number", -- Unique number assigned to each offender
"supervision_status", -- Supervision status of the offender
"record_date" -- Date associated when data report was run.
FROM
"mydata-iowa-gov/current-iowa-correctional-system-prison-population-xbcv-c6t2:latest"."current_iowa_correctional_system_prison_population"
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 mydata-iowa-gov/current-iowa-correctional-system-prison-population-xbcv-c6t2 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 mydata-iowa-gov/current-iowa-correctional-system-prison-population-xbcv-c6t2: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 mydata-iowa-gov/current-iowa-correctional-system-prison-population-xbcv-c6t2Checkout 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 mydata-iowa-gov/current-iowa-correctional-system-prison-population-xbcv-c6t2:latestThis will download all the objects for the latest tag of mydata-iowa-gov/current-iowa-correctional-system-prison-population-xbcv-c6t2 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 mydata-iowa-gov/current-iowa-correctional-system-prison-population-xbcv-c6t2: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 mydata-iowa-gov/current-iowa-correctional-system-prison-population-xbcv-c6t2: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, mydata-iowa-gov/current-iowa-correctional-system-prison-population-xbcv-c6t2 is just another Postgres schema.