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-myag-hymh:latest"."summer_meal_programs_summer_food_service_program"or in a full query, like:
SELECT
":id", -- Socrata column ID
"suppertime", -- Time supper service starts and ends. Data displayed as: H:MM – H:MM
"pmsnacktime", -- Time afternoon snack service starts and ends. Data displayed as: H:MM – H:MM
"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)
"breakfasttime", -- Time breakfast service starts and ends. Data displayed as: H:MM – H:MM
"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
"sitestartdate", -- Operational start date for the site
"sitestreetaddressline2", -- Site street address, line 2 (if applicable)
"primaryauthorizedreprese_5", -- Primary authorized representative phone number
"sfspcontactphone", -- Program contact phone number
"sfspcontacttitleposition", -- Program contact title or position
"cestreetaddresszipcode", -- Contracting Entity (CE) street address, zip code
"countydistrictcode", -- County District Code for county in which Contracting Entity (CE) in located
"lunchtime", -- Time lunch 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
"geocoded_column", -- Geo-location 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.
"sitesupervisorfirstname", -- Site supervisor first name
"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
"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
"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
"siteenddate", -- Operational end date for the site
"sitesupervisortitleposition", -- Site supervisor title or position
"sitemailingaddresscity", -- Site mailing address, city
"sitestreetaddresszipcode", -- Site street address, zip code
"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)
"sitestreetaddresscity", -- Site street address, city
"sitestreetaddressline1", -- Site street address, line 1
"primaryauthorizedreprese_3", -- Primary authorized representative title or position
"sfspcontactemail", -- Program contact email address
"sfspcontactlastname", -- Program contact last name
"cemailingaddresszipcode", -- Contracting Entity (CE) mailing address, zip code
"cemailingaddressline2", -- Contracting Entity (CE) mailing address, line 2 (if applicable)
"cestreetaddresscity", -- Contracting Entity (CE) street address, city
"cestreetaddressline2", -- Contracting Entity (CE) street address, line 2 (if applicable)
"cestreetaddressline1", -- Contracting Entity (CE) street address, line 1
"cecounty", -- County in which the Contracting Entity (CE) is located
"primaryauthorizedreprese_2", -- Primary authorized representative last name
"cename", -- Contracting Entity (CE) name
"amsnacktime", -- Time morning snack service starts and ends. Data displayed as: H:MM – H:MM
"cemailingaddressline1", -- Contracting Entity (CE) mailing address, line 1
"primaryauthorizedreprese", -- Honorific salutation for primary authorized representative. Optional entry. Format: Mr., Ms. Dr., etc.
"sitesupervisorsalutation", -- Honorific salutation for site contact. Optional entry. Format: Mr., Ms. Dr., etc.
"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
"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)
"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)
"sitemailingaddresszipcode", -- Site mailing address, zip code
"sitename", -- Site name
"cemailingaddresscity", -- Contracting Entity (CE) mailing address, city
"sitesupervisorphone", -- Site supervisor phone number
"siteid", -- Number assigned to identify site within CE
"sitesupervisoremail", -- Site supervisor email address
"sitemailingaddressline1", -- Site mailing address, line 1
"ruralorurbancode", -- Geographic location description of the participating site. Data displayed as: Rural/Urban
"primaryauthorizedreprese_4", -- Primary authorized representative email address
"sfspcontactfirstname", -- Program contact first name
"sfspcontactsalutation", -- Honorific salutation for program contact. Optional entry. Format: Mr., Ms. Dr., etc.
"cemailingaddressstate", -- Contracting Entity (CE) mailing address, state
"cestreetaddressstate", -- Contracting Entity (CE) street address, state
"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
"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
"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)
"sitesupervisorlastname", -- Site supervisor last name
"sitemailingaddressstate", -- Site mailing address, state
"typeofsfsporg", -- 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.
"ceid", -- Unique number assigned to Contracting Entity (CE) to identify organization as a program sponsor
"primaryauthorizedreprese_1", -- Primary authorized representative first name
"sitestreetaddressstate", -- Site street address, state
"sitecounty", -- County in which the site is located
"tdaregion", -- Texas Department of Agriculture (TDA) service region
"esc", -- Educational Service Center (ESC) region
"reporttype", -- Type of information being reported in the dataset
":@computed_region_346f_s9gh",
":@computed_region_hy99_5a2i",
":@computed_region_fd5q_j34z",
":@computed_region_9y59_55ru",
":@computed_region_ywmh_rrwq",
"sitemailingaddressline2" -- Site mailing address, line 2 (if applicable)
FROM
"texas-gov/summer-meal-programs-summer-food-service-program-myag-hymh: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-myag-hymh 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/summer-meal-programs-summer-food-service-program-myag-hymh: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/summer-meal-programs-summer-food-service-program-myag-hymhCheckout 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/summer-meal-programs-summer-food-service-program-myag-hymh:latestThis will download all the objects for the latest tag of texas-gov/summer-meal-programs-summer-food-service-program-myag-hymh 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/summer-meal-programs-summer-food-service-program-myag-hymh: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/summer-meal-programs-summer-food-service-program-myag-hymh: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/summer-meal-programs-summer-food-service-program-myag-hymh is just another Postgres schema.