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_care_regulated_programs table in this repository, by referencing it like:
"ny-gov/child-care-regulated-programs-cb42-qumz:latest"."child_care_regulated_programs"or in a full query, like:
SELECT
":id", -- Socrata column ID
"provider_name", -- Name of On-Site Provider/Director (Last name, First name). If not approved, “There is no approved Director/On-Site Provider at this site” appears
"phone_number", -- Phone number of the program. Excluded for providers who have unlisted phone numbers
":@computed_region_kjdx_g34t", -- This column was automatically created in order to record in what polygon from the dataset 'Counties' (kjdx-g34t) the point in column 'georeference' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"zip_code", -- Zip code of the city the program is located in.
"phone_number_omitted", -- Excluded for providers who have unlisted phone numbers. "Y" indicates they opted out or have an unlisted number, blank indicates they did not.
"city", -- City the program is located in.
"license_issue_date", -- Date a license was issued for the facility
"longitude", -- As a result of a bill signed into law (Chapter 354 of the Laws of 2009), the dataset omits addresses for those child care providers who have “opted out” from having their addresses and map included.
"infant_capacity", -- For DCC, total number of children up to 18 months of age
"street_name", -- Street name of the address of the program. Excluded if provider has opted out
"additional_information", -- Overview information of the program and violation history. This does not include the results of inspections where no violations are cited.
":@computed_region_yamh_8v7k", -- This column was automatically created in order to record in what polygon from the dataset 'NYS Municipal Boundaries' (yamh-8v7k) the point in column 'georeference' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
":@computed_region_wbg7_3whc", -- This column was automatically created in order to record in what polygon from the dataset 'New York Zip Codes' (wbg7-3whc) the point in column 'georeference' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"license_expiration_date", -- Date the license for the facility will expire.
"apartment", -- Apartment info of the address of the program. Excluded if provider has opted out or it does not apply.
"program_type", -- FDC = Family Day Care; GFDC = Group Family Day Care; SACC = School Age Child Care; DCC = Day Care Center; SDCC = Small Day Care Center
"facility_status", -- License = GFDC or DCC; Registration = FDC, SACC, SDCC; Pending Revocation = recommended for revocation; Pending Revocation & Denial = recommended for revocation/denial; Pending Denial = recommended for denial; Suspended = may not care for children
"state", -- State the program is located in.
"capacity_description", -- This only applies if the Program Type is Family Day Care (FDC) or Group Family Day Care (GFDC).
"latitude", -- As a result of a bill signed into law (Chapter 354 of the Laws of 2009), the dataset omits addresses for those child care providers who have “opted out” from having their addresses and map included.
"phone_extension", -- Phone extension for the program phone number. Excluded if provider has opted out, has unlisted phone number or if there is none.
"preschool_capacity", -- For DCC, total number of children at least 3 years of age who are not yet enrolled in kindergarten or a higher grade
"additional_address", -- Additional address information for the program. Excluded if provider has opted out or if it does not apply.
"school_district_name", -- Name of School District in which Program is located
"facility_id", -- Unique number automatically generated at Children and Family Services to identify an individual facility.
"county", -- County in which the facility is located.
"facility_name", -- DBA (legal entity/doing business as) name or Legal Name (last name, first name)
"toddler_capacity", -- For DCC, total number of children ages 18 months to 36 months
"facility_opened_date", -- Date the facility began operation.
"street_number", -- Street number portion of the address of the program. Excluded if provider has opted out
"floor", -- Floor detail of the address of the program. Excluded if provider has opted out or if it does not apply.
"school_age_capacity", -- For DCC and SACC, total number of children who are under 13 years of age who are enrolled in kindergarten or a higher grade
"address_omitted", -- As a result of a bill signed into law (Chapter 354 of the Laws of 2009), the dataset omits addresses for those child care providers who have “opted out” from having their addresses and map included. "Y" indicates they opted out, blank indicates they did not.
"georeference", -- Open Data/Socrata-generated geocoding information from supplied address components.
"region_code", -- ARO =Albany Regional Office; BRO =Buffalo Regional Office; LIRO = Long Island Regional Office; NYCDOHMH =NYC Department of Health and Mental Hygiene; RRO = Rochester Regional Office; SRO = Syracuse Regional Office; YRO = Spring Valley Regional Office
"total_capacity" -- Refer to the data dictionary found in the About tab for the definition of Total Capacity.
FROM
"ny-gov/child-care-regulated-programs-cb42-qumz:latest"."child_care_regulated_programs"
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/child-care-regulated-programs-cb42-qumz 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/child-care-regulated-programs-cb42-qumz: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/child-care-regulated-programs-cb42-qumzCheckout 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/child-care-regulated-programs-cb42-qumz:latestThis will download all the objects for the latest tag of ny-gov/child-care-regulated-programs-cb42-qumz 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/child-care-regulated-programs-cb42-qumz: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/child-care-regulated-programs-cb42-qumz: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/child-care-regulated-programs-cb42-qumz is just another Postgres schema.