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_programs_cacfp_centers table in this repository, by referencing it like:
"texas-gov/child-and-adult-care-food-programs-cacfp-centers-wfet-4eiw:latest"."child_and_adult_care_food_programs_cacfp_centers"or in a full query, like:
SELECT
":id", -- Socrata column ID
"applicationeffectivedate", -- Date Contracting Entity (CE) is approved to begin program participation for program year.
"geocoded_column", -- Geolocation of site based on site street address for map visualization. Null values in geolocation data is most likely due to a P.O. Box address listed for a site address.
"foodservicevendorname", -- Name of food service vendor if site uses a food service contract
"foodservicecontract", -- Indicates whether site has a food service contract. Data displayed as: Y/N. For more information on Food Service Vendors, please refer to the Food Service Management Company (FSMC) data set.
"mealsservicemethod", -- Method used by site to serve meals. Data is displayed as: Unit (Cafeteria)/Family
"mealspreparationmethod", -- Method used by site to prepare meals. Data displayed as: Prepared on site/Prepared at Central Facility and Delivered/Contracted with a Public School/Purchased from a food service vendor/Other. Selection of multiple methods is possible.
"agerangeofparticipants", -- Age range of participants enrolled at site. Data displayed as: # Yrs # Mnths - # Yrs to # Mnths
"totalparticipantsenrolled", -- Total number of participants enrolled in the calendar month preceding program application
"sitelicensecapacity", -- If site is licensed, participant capacity as per site license
"sitelicensenumber", -- If site is licensed, license number
"at_riskonly", -- Site operates as an At-Risk center only. Data displayed as: Y/N
"at_riskafterschoolcarecenter", -- Site operates as an At-Risk afterschool care center (At-Risk). Data displayed as: Y/N
"headstart", -- Site operates as a Head Start center. Data displayed as: Y/N
"emergencyshelter", -- Site operates as an emergency shelter. Data displayed as: Y/N
"outsideschoolhours", -- Site operates as an outside school hours center. Data displayed as: Y/N
"childcare", -- Site operates as a child care center (CCC). Data displayed as: Y/N
"adultcarecenter", -- Site operates as an adult day care (ADC) center. Data displayed as: Y/N
"siteaffiliation", -- “Affiliated” is defined as the site being sponsored by the Contracting Entity (CE) organization AND is part of the CE organization. “Unaffiliated” is defined as the site being sponsored by the Contracting Entity (CE), but is NOT part of the CE organization. Data displayed as: Affiliated/Unaffiliated
"sitecontactphone", -- Site contact phone number. Site contact is the person in charge of this center on a daily basis.
"sitecontactemail", -- Site contact email address. Site contact is the person in charge of this center on a daily basis.
"sitecontacttitleposition", -- Site contact title or position. Site contact is the person in charge of this center on a daily basis.
"sitecontactlastname", -- Site contact last name. Site contact is the person in charge of this center on a daily basis.
"sitecontactfirstname", -- Site contact first name. Site contact is the person in charge of this center on a daily basis.
"sitecontactsalutation", -- Honorific salutation for site contact. Optional entry. Format: Mr., Ms. Dr., etc.
"sitemailingaddressstate", -- Site mailing address, state
"sitemailingaddresscity", -- Site mailing address, city
"sitemailingaddressline2", -- Site mailing address, line 2 (if applicable)
"sitemailingaddressline1", -- Site mailing address, line 1
"sitestreetaddresszipcode", -- Site street address, zip code
"sitestreetaddresscity", -- Site street address, city
"sitestreetaddressline2", -- Site street address, line 2 (if applicable)
"sitestreetaddressline1", -- Site street address, line 1
"taxstatusdescription", -- Explanation if “Other” was selected for Site Tax Status
"taxstatus", -- Tax status site files under. Data displayed as: For Profit/Non Profit/Other/Public
"sitecounty", -- County in which the site is located
"sitename", -- Site name
"siteid", -- Number assigned to identify site within CE
"ceadministratorphone", -- CE administrator phone number
"ceadministratoremail", -- CE administrator email address
"ceadministratortitleposition", -- CE administrator title or position
"ceadministratorlastname", -- CE administrator last name
"ceadministratorfirstname", -- CE administrator first name
"ceadministratorsalutation", -- Honorific salutation for CE administrator. Optional entry for CE. Format: Mr., Ms., Dr., etc.
"cemailingaddresszipcode", -- Contracting Entity (CE) mailing address, zip code
"cemailingaddressstate", -- Contracting Entity (CE) mailing address, state
"cemailingaddresscity", -- Contracting Entity (CE) mailing address, city
"cemailingaddressline2", -- Contracting Entity (CE) mailing address, line 2 (if applicable)
"cemailingaddressline1", -- Contracting Entity (CE) mailing address, line 1
"cestreetaddresszipcode", -- Contracting Entity (CE) street address, zip code
"cestreetaddressstate", -- Contracting Entity (CE) street address, state
"cestreetaddresscity", -- Contracting Entity (CE) street address, city
"cestreetaddressline2", -- Contracting Entity (CE) street address, line 2 (if applicable)
"cestreetaddressline1", -- Contracting Entity (CE) street address, line 2 (if applicable)
"tdaregion", -- Contracting Entity (CE) street address, line 1
"esc", -- Educational Service Center (ESC) region
"countydistrictcode", -- County District Code for county in which site in located
"typeofagency", -- Type of agency the Contracting Entity (CE) operates as. Data displayed as: Educational Institution/For Profit Organization/Government Agency/Indian Tribe/Military Installation/Private Non Profit Organization
"typeofceorg", -- Type of organization the Contracting Entity (CE) operates as. Data displayed as: Independent Center/Sponsor of Affiliated & Unaffiliated Sites/Sponsor of Affiliated Sites/Sponsor of Unaffiliated Sites
"cecounty", -- County in which the Contracting Entity (CE) is located
"cename", -- Contracting Entity (CE) name
"ceid", -- Unique number assigned to Contracting Entity (CE) to identify organization as program sponsor
"reporttype", -- Type of information being reported in the dataset
"programyear", -- A program year for Child and Adult Care Food Programs (CACFP) is defined as October 1 of one year through September 30 of the following year.
":@computed_region_9y59_55ru",
":@computed_region_fd5q_j34z",
":@computed_region_ywmh_rrwq",
":@computed_region_hy99_5a2i",
":@computed_region_346f_s9gh",
"sitemailingaddresszipcode", -- Site mailing address, zip code
"sitestreetaddressstate" -- Site street address, state
FROM
"texas-gov/child-and-adult-care-food-programs-cacfp-centers-wfet-4eiw:latest"."child_and_adult_care_food_programs_cacfp_centers"
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 texas-gov/child-and-adult-care-food-programs-cacfp-centers-wfet-4eiw 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 texas-gov/child-and-adult-care-food-programs-cacfp-centers-wfet-4eiw: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 texas-gov/child-and-adult-care-food-programs-cacfp-centers-wfet-4eiwCheckout 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 texas-gov/child-and-adult-care-food-programs-cacfp-centers-wfet-4eiw:latestThis will download all the objects for the latest tag of texas-gov/child-and-adult-care-food-programs-cacfp-centers-wfet-4eiw 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 texas-gov/child-and-adult-care-food-programs-cacfp-centers-wfet-4eiw: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 texas-gov/child-and-adult-care-food-programs-cacfp-centers-wfet-4eiw: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, texas-gov/child-and-adult-care-food-programs-cacfp-centers-wfet-4eiw is just another Postgres schema.