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 funded_and_licensed_child_care_providers
table in this repository, by referencing it like:
"educationtocareer-data-mass-gov/funded-and-licensed-child-care-providers-dn4d-tjbb:latest"."funded_and_licensed_child_care_providers"
or in a full query, like:
SELECT
":id", -- Socrata column ID
"infant_birth15mo", -- Provider’s infant capacity
"toddlerpreschool_15mok", -- Provider’s toddler/preschool capacity
"preschool_33mok", -- Provider's preschool capacity
"preschoolsa_33mo8yr", -- Provider's preschool/school age capacity
"kindergarten", -- Provider's kindergarten capacity
"schoolage_5yr14yr", -- Provider's school age capacity
"multiagegroup_birth14yr", -- Provider's multi-age group capacity. Not available for data pulled on 7/01/2022 to 10/01/2022
"zipcode_tabulation_svi", -- A composite measure, designed by the Center for Disease Control and Prevention, to determine the relative social vulnerability of every census tract. EEC uses the SVI of the census tract and the zip code in which a provider is located as part of the formula for its Commonwealth Cares for Children (C3) formula. This measure is not available for public schools. Recently licensed programs may not yet have an SVI. For more information on the SVI measure, see the following website: https://www.atsdr.cdc.gov/placeandhealth/svi/index.html
"censustracts_svi", -- The composite, CDC designed SVI measure described above, but recalculated at the zip code rather than census tract level. This measure is not available for public schools. Recently licensed programs may not yet have an SVI.
"datapulled_date", -- The date the data was pulled from EEC’s Licensing Education Analytic Database (LEAD)
"kindergarten_schoolage", -- Provider's kindergarten/school age capacity
"name", -- Program name
"phone", -- Program phone number
"subsidy_region", -- Region for the purpose of subsidy administration
"licensed_funded", -- Program's status as licensed or funded.
"licensed_capacity", -- The total number of children that a provider can serve at a given time. Note: 1) Licensed capacity by age is not available for Family Child Care providers or Group and School Age programs with a capacity of 10 or fewer children. 2) Family Child Care providers' license capacity usually start at 6 and vary between 6-10. In some cases, a provider cannot be approved to care for 6 children due to factors such as lack of sufficient space. 3) Classrooms in Group and School Age programs often overlap age groups, so capacity by age will not equal licensed capacity. For instance, if a preschool program uses the same space as the after-school school-age program, both preschool and after school capacities would be listed, but both groups cannot be in attendance at the same time because they occupy the same space, so licensed capacity would be lower than the sum of capacity by age.
"infanttoddler_birth33mo", -- Provider’s infant/toddler capacity
"provider_number", -- Unique Program ID (P-#) from EEC’s Licensing Education Analytic Database (LEAD)
"umbrella", -- Program umbrella organization
"street_address1", -- Program address (street) (line 1)
"street_address2", -- Program address (street) (line2)
"city", -- Program city
"zipcode", -- Program zip code
"licensing_region", -- Regional office that oversees program’s licensing
"program_type", -- Type of Child Care Providers (Family Child Care, Group and School Age, Public School, Private School)
"first_issued_date", -- Date the program first received license from EEC or was approved to be funded by EEC
"toddler_15mo33mo" -- Provider’s toddler capacity
FROM
"educationtocareer-data-mass-gov/funded-and-licensed-child-care-providers-dn4d-tjbb:latest"."funded_and_licensed_child_care_providers"
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 educationtocareer-data-mass-gov/funded-and-licensed-child-care-providers-dn4d-tjbb
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 educationtocareer-data-mass-gov/funded-and-licensed-child-care-providers-dn4d-tjbb: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 educationtocareer-data-mass-gov/funded-and-licensed-child-care-providers-dn4d-tjbb
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 educationtocareer-data-mass-gov/funded-and-licensed-child-care-providers-dn4d-tjbb:latest
This will download all the objects for the latest
tag of educationtocareer-data-mass-gov/funded-and-licensed-child-care-providers-dn4d-tjbb
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 educationtocareer-data-mass-gov/funded-and-licensed-child-care-providers-dn4d-tjbb: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 educationtocareer-data-mass-gov/funded-and-licensed-child-care-providers-dn4d-tjbb: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, educationtocareer-data-mass-gov/funded-and-licensed-child-care-providers-dn4d-tjbb
is just another Postgres schema.