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 child_and_adult_care_food_program_participation
table in this repository, by referencing it like:
"health-data-ny-gov/child-and-adult-care-food-program-participation-dmn7-mpa8:latest"."child_and_adult_care_food_program_participation"
or in a full query, like:
SELECT
":id", -- Socrata column ID
"zipcode", -- Zip code of the participating site
"zipcode_address",
"street2", -- Street Address2 of the participating site
"site_name", -- Name of the participating site
"location_address",
"location", -- Location
"last_ewphdch_participation", -- The most recent year a center has participated in the EWPHDCH program
"county", -- Counties where the participating site is located
"city", -- City of the participating site
"street1", -- Street Address1 of the participating site
"address_omitted", -- A “Y” value indicates the address is not included in the dataset. Addresses have been omitted for regulated child care providers that provide home care since this information is available on Open.ny.gov by using this link: https://data.ny.gov/Human-Services/Child-Care-Regulated-Programs/cb42-qumz
"eat_well_play_hard_ccs_participant", -- Day Care Center sites that have completed the full Eat Well Play Hard in Child Care Settings (EWPHCCS) educational program of child, parent and staff classes. Values are Yes and No.
"location_state",
"zipcode_state",
"state", -- State the participating site is located
"approval_license_type", -- Approval /License Type of the participating site
"location_zip",
"program_type", -- Program Type of the participating site (Home or Center)
"last_ewphccs_participation", -- The most recent year a center has participated in the Eat Well Play Hard in Child Care Settings program
"location_city",
"eat_well_play_hard_dch_participant", -- Day Care Home Provider Sites that have completed the full Eat Well Play Hard in Day Care Homes (EWPHDCH) environmental program requirements. In particular, DCH providers are asked to focus on increasing the variety of fruits and vegetables offered at the DCH and increasing opportunities for adult-led structured play. Values are Yes and No.
"zipcode_zip",
"breastfeeding_friendly_certified", -- The Child and Adult Care Food Program encourages child care centers and family day care homes to support breastfeeding families and recognizes these providers with Breastfeeding Friendly certificates. Participating sites that have completed the requirements to obtain a certificate are designated as Breastfeeding Friendly. Values are Yes and No.
"site_type", -- Site types are: Adult Care, Child Care, Head Start, Licensed, Military, Registered, School Age, and Tribal
"zipcode_city"
FROM
"health-data-ny-gov/child-and-adult-care-food-program-participation-dmn7-mpa8:latest"."child_and_adult_care_food_program_participation"
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 health-data-ny-gov/child-and-adult-care-food-program-participation-dmn7-mpa8
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; sgr
can 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 clone
and sgr checkout
.
Cloning Data
Because health-data-ny-gov/child-and-adult-care-food-program-participation-dmn7-mpa8: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 health-data-ny-gov/child-and-adult-care-food-program-participation-dmn7-mpa8
Checkout 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 health-data-ny-gov/child-and-adult-care-food-program-participation-dmn7-mpa8:latest
This will download all the objects for the latest
tag of health-data-ny-gov/child-and-adult-care-food-program-participation-dmn7-mpa8
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 health-data-ny-gov/child-and-adult-care-food-program-participation-dmn7-mpa8: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 health-data-ny-gov/child-and-adult-care-food-program-participation-dmn7-mpa8:latest
This 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, health-data-ny-gov/child-and-adult-care-food-program-participation-dmn7-mpa8
is just another Postgres schema.