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 asotin_county_immunization_data_by_school table in this repository, by referencing it like:
"wa-gov/asotin-county-immunization-data-by-school-jzrz-dku2:latest"."asotin_county_immunization_data_by_school"or in a full query, like:
SELECT
":id", -- Socrata column ID
"number_exempt_for_pertussis", -- Number of students with an examption for pertussis
"type_of_school", -- Indicates whether school is public or private
"percent_exempt_for_hepatitisb", -- Percentage of students with an exemption for hepatitis b
"school_year", -- School year in which immunizations were reported
"number_with_medical_exemption", -- Number of students with a medical exemption
"percent_exempt_for_varicella", -- Percentage of students with an exemption for varicella
"percent_complete_for_all", -- Percentage of students with completed immunizations
"number_with_religious", -- Number of students with a religious exemption
"reported_enrollment", -- Number of students enrolled in the school
"number_exempt_for_varicella", -- Number of students with varicella
"number_with_any_exemption", -- Number of students with any exemptions
"reported", -- Indicates whether or not school immunization rates were reported
"percent_with_any_exemption", -- Percentage of students with any exemption
"school_name", -- Name of school
"school_district", -- School District in which school is located
"percent_exempt_for_diphtheria", -- Percentage of students with an exemption for diphtheria/tetanus
"percent_with_personal", -- Percentage of students with a personal exemption
"number_exempt_for_hepatitisb", -- Number of students withan examption for hepatitis b
"has_6thgrade", -- Indicates whether or not school includes sixth grade
"number_with_religious_1", -- Number of students with religious membership exemption
"county", -- County in which school is located
"city", -- City in which school is located
"percent_exempt_for_polio", -- Percentage of students with an exemption for polio
"percent_with_medical_exemption", -- Percentage of students with a medical exemption
"address", -- Mailing address of school
"number_exempt_for_measles", -- Number of students with an examption for measles/mumps/rubella
"grade_levels", -- Grade levels taught in school building
"number_with_personal_exemption", -- Number of students with a personal exemption
"number_complete_for_all", -- Number of students with all immunizations
"percent_exempt_for_pertussis", -- Percentage of students with an exemption for pertussis
"percent_exempt_for_measles", -- Percentage of students with an exemption for measles/mumps/rubella
"percent_with_religious_1", -- Percentage of students with religious membership exemption
"has_kindergarten", -- Indicates whether or not school includes kindergarten
"percent_with_religious", -- Percentage of students with religious exemption
"esd", -- Educational Service District in which school is located
"number_exempt_for_polio", -- Number of students with an examption for polio
"number_exempt_for_diphtheria" -- Number of students with an examption for diptheria/tetanus
FROM
"wa-gov/asotin-county-immunization-data-by-school-jzrz-dku2:latest"."asotin_county_immunization_data_by_school"
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 wa-gov/asotin-county-immunization-data-by-school-jzrz-dku2 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 wa-gov/asotin-county-immunization-data-by-school-jzrz-dku2: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 wa-gov/asotin-county-immunization-data-by-school-jzrz-dku2Checkout 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 wa-gov/asotin-county-immunization-data-by-school-jzrz-dku2:latestThis will download all the objects for the latest tag of wa-gov/asotin-county-immunization-data-by-school-jzrz-dku2 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 wa-gov/asotin-county-immunization-data-by-school-jzrz-dku2: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 wa-gov/asotin-county-immunization-data-by-school-jzrz-dku2: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, wa-gov/asotin-county-immunization-data-by-school-jzrz-dku2 is just another Postgres schema.