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 summer_meal_programs_summer_food_service_program table in this repository, by referencing it like:
"texas-gov/summer-meal-programs-summer-food-service-program-jsqy-awcw:latest"."summer_meal_programs_summer_food_service_program"or in a full query, like:
SELECT
":id", -- Socrata column ID
"supperdaysserved", -- Days of the week supper served at the site during operation Data displayed as: S/M/T/W/TH/F/SA; multiple days separated by commas
"pmsnackdaysserved", -- Days of the week afternoon snacks served at the site during operation Data displayed as: S/M/T/W/TH/F/SA; multiple days separated by commas
"pmsnackmealservicemethod", -- Method of afternoon snack preparation. Data displayed as: Self-Prep-Prepares on site/Self-Prep-Receives meals (Central Kitchen)/Vended by another SFSP Contracting Entity/Vended by Food Service Management Company (FSMC)/Vended by School Food Authority (SFA)/(blank)
"lunchdaysserved", -- Days of the week lunch served at the site during operation Data displayed as: S/M/T/W/TH/F/SA; multiple entries separated by commas
"lunchmealservicemethod", -- Method of lunch preparation. Data displayed as: Self-Prep-Prepares on site/Self-Prep-Receives meals (Central Kitchen)/Vended by another SFSP Contracting Entity/Vended by Food Service Management Company (FSMC)/Vended by School Food Authority (SFA)/(blank)
"lunchtime", -- Time lunch service starts and ends. Data displayed as: H:MM – H:MM
"amsnackmealservicemethod", -- Method of morning snack preparation. Data displayed as: Self-Prep-Prepares on site/Self-Prep-Receives meals (Central Kitchen)/Vended by another SFSP Contracting Entity/Vended by Food Service Management Company (FSMC)/Vended by School Food Authority (SFA)/(blank)
"amsnacktime", -- Time morning snack service starts and ends. Data displayed as: H:MM – H:MM
"breakfastdaysserved", -- Days of the week breakfast served at the site during operation Data displayed as: S/M/T/W/TH/F/SA; multiple entries separated by commas
"breakfastmealservicemethod", -- Method of breakfast preparation. Data displayed as: Self-Prep-Prepares on site/Self-Prep-Receives meals (Central Kitchen)/Vended by another SFSP Contracting Entity/Vended by Food Service Management Company (FSMC)/Vended by School Food Authority (SFA)/(blank)
"mealtypesserved", -- Type of meals served at the site during operation. Data displayed as: Breakfast/Lunch/Dinner/AM Snack/PM Snack; multiple entries separated by commas
"daysofoperation", -- Days of the week meals served at the site during operation. Data displayed as: S/M/T/W/TH/F/SA; multiple entries separated by commas
"siteenddate", -- Operational end date for the site
"sitestartdate", -- Operational start date for the site
"sitetype", -- Site type description. Data displayed as: Camp-Non-Residential/Camp-Residential/Closed-Enrolled in Needy Area/Closed-Enrolled in Non-Needy Area/Homeless (site is not a residential child care institution)/Open/Restricted Open
"sitesupervisoremail", -- Site supervisor email address
"sitesupervisortitleposition", -- Site supervisor title or position
"primaryauthorizedreprese_5", -- Primary authorized representative email address
"primaryauthorizedreprese_4", -- Primary authorized representative phone number
"primaryauthorizedreprese_3", -- Primary authorized representative title or position
"sfspcontactphone", -- Program contact phone number
"sfspcontactlastname", -- Program contact last name
"sfspcontactfirstname", -- Program contact first name
"sfspcontactsalutation", -- Honorific salutation for program contact. Optional entry. Format: Mr., Ms. Dr., etc.
"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
"cemailingaddresscity", -- Contracting Entity (CE) mailing address, city
"cemailingaddressline1", -- Contracting Entity (CE) mailing address, line 1
"cestreetaddresscity", -- Contracting Entity (CE) street address, city
"cestreetaddressline2", -- Contracting Entity (CE) street address, line 2 (if applicable)
"cecounty", -- County in which the Contracting Entity (CE) is located
"siteterminatedasofdate", -- Date that participation in this TDA nutrition program effectively ends for the site. Data displayed as: MM/DD/YYYY / (blank – not terminated)
"ceterminatedasofdate", -- Date that participation in this TDA nutrition program effectively ends for the Contracting Entity (CE). Data displayed as: MM/DD/YYYY / (blank – not terminated).
"esc", -- Educational Service Center (ESC) region
"cename", -- Contracting Entity (CE) name
"ceid", -- Unique number assigned to Contracting Entity (CE) to identify organization as a program sponsor
"reporttype", -- Type of information being reported in the dataset
"geocoded_column", -- Geo-location of site based on site street address for map visualization.
"suppermealservicemethod", -- Method of supper preparation. Data displayed as: Self-Prep-Prepares on site/Self-Prep-Receives meals (Central Kitchen)/Vended by another SFSP Contracting Entity/Vended by Food Service Management Company (FSMC)/Vended by School Food Authority (SFA)/(blank)
"pmsnacktime", -- Time afternoon snack service starts and ends. Data displayed as: H:MM – H:MM
"amsnackdaysserved", -- Days of the week morning snacks served at the site during operation Data displayed as: S/M/T/W/TH/F/SA; multiple entries separated by commas
"breakfasttime", -- Time breakfast service starts and ends. Data displayed as: H:MM – H:MM
"sitesupervisorphone", -- Site supervisor phone number
"primaryauthorizedreprese_1", -- Primary authorized representative first name
"primaryauthorizedreprese", -- Honorific salutation for primary authorized representative. Optional entry. Format: Mr., Ms. Dr., etc.
"sfspcontactemail", -- Program contact email address
"sitestreetaddressstate", -- Site street address, state
"cemailingaddresszipcode", -- Contracting Entity (CE) mailing address, zip code
"cemailingaddressstate", -- Contracting Entity (CE) mailing address, state
"cemailingaddressline2", -- Contracting Entity (CE) mailing address, line 2 (if applicable)
"cestreetaddresszipcode", -- Contracting Entity (CE) street address, zip code
"cestreetaddressline1", -- Contracting Entity (CE) street address, line 1
"countydistrictcode", -- County District Code for county in which Contracting Entity (CE) in located
"sitename", -- Site name
"sitesupervisorsalutation", -- Honorific salutation for site contact. Optional entry. Format: Mr., Ms. Dr., etc.
"ceterminationstatus", -- Termination category for Contracting Entity (CE) that is no longer participating in this TDA nutrition program. Data displayed as: Self Cancelled/TDA cancelled/(blank – not terminated).
"typeofagency", -- Type of agency the Contracting Entity (CE) operates as. Data displayed as: Educational Institution/Government Agency/Indian Tribe/Military Installation/Private Non-Profit Organization/Other
"sitesupervisorlastname", -- Site supervisor last name
"sitesupervisorfirstname", -- Site supervisor first name
"primaryauthorizedreprese_2", -- Primary authorized representative last name
"sfspcontacttitleposition", -- Program contact title or position
"sitemailingaddresszipcode", -- Site mailing address, zip code
"cestreetaddressstate", -- Contracting Entity (CE) street address, state
"covidmealsite", -- COVID-19 Meal Site indicator, Indicates whether site is operating under USDA flexibilities offered in response to the COVID-19 pandemic. Data displayed as: Yes/No.
"siteid", -- Identification number assigned to site within CE
"tdaregion", -- Texas Department of Agriculture (TDA) service region
"suppertime", -- Time supper service starts and ends. Data displayed as: H:MM – H:MM
"sitemailingaddressstate", -- Site mailing address, state
"sitecounty", -- County in which the site is located
"sitestatus", -- Site is eligible and/or participating in nutrition program. Data displayed as: Active/Inactive
"cestatus", -- Contracting Entity is eligible and/or participating in nutrition program. Data displayed as: Active/Inactive
"ruralorurbancode", -- Geographic location description of the participating site. Data displayed as: Rural/Urban
"siteterminationstatus", -- Termination category for site that is no longer participating in this TDA nutrition program. Data for SFSP displayed as: Contracting Entity Closed /Self Cancelled/TDA cancelled/TDA Terminated(blank – not terminated)
"ceapplicationcycle", -- Description of Contracting Entity (CE) application type based on program participation in previous program year. Data displayed as: Continuing/NewApp/Renewal.
"typeoforg", -- Site designation for type of organization. Data displayed as: Nonresidential Summer Camp/Private Non Profit/Residential Camp/School Food Authority/Unit of Government
"programyear", -- A program period for summer meal programs is defined as mid-May through the end of August for the same calendar year.
":@computed_region_fd5q_j34z",
":@computed_region_ywmh_rrwq",
":@computed_region_hy99_5a2i",
":@computed_region_346f_s9gh",
":@computed_region_9y59_55ru"
FROM
"texas-gov/summer-meal-programs-summer-food-service-program-jsqy-awcw:latest"."summer_meal_programs_summer_food_service_program"
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/summer-meal-programs-summer-food-service-program-jsqy-awcw with SQL in under 60 seconds.
This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.texas.gov. When you querytexas-gov/summer-meal-programs-summer-food-service-program-jsqy-awcw:latest on the DDN, we "mount" the repository using the socrata mount handler. The mount handler proxies your SQL query to the upstream data source, translating it from SQL to the relevant language (in this case SoQL).
We also cache query responses on the DDN, but we run the DDN on multiple nodes so a CACHE_HIT is only guaranteed for subsequent queries that land on the same node.
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 (like this repository), 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, where the author has pushed Splitgraph Images to the repository, you can "clone" and/or "checkout" the data using sgr cloneand sgr checkout.
Mounting Data
This repository is an external repository. It's not hosted by Splitgraph. It is hosted by data.texas.gov, and Splitgraph indexes it. This means it is not an actual Splitgraph image, so you cannot use sgr clone to get the data. Instead, you can use the socrata adapter with the sgr mount command. Then, if you want, you can import the data and turn it into a Splitgraph image that others can clone.
First, install Splitgraph if you haven't already.
Mount the table with sgr mount
sgr mount socrata \
"texas-gov/summer-meal-programs-summer-food-service-program-jsqy-awcw" \
--handler-options '{
"domain": "data.texas.gov",
"tables": {
"summer_meal_programs_summer_food_service_program": "jsqy-awcw"
}
}'That's it! Now you can query the data in the mounted table like any other Postgres table.
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/summer-meal-programs-summer-food-service-program-jsqy-awcw is just another Postgres schema.