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_all_summer_sites_contact_and table in this repository, by referencing it like:
"texas-gov/summer-meal-programs-all-summer-sites-contact-and-aj5s-8pui:latest"."summer_meal_programs_all_summer_sites_contact_and"or in a full query, like:
SELECT
":id", -- Socrata column ID
"operationstartdate", -- Contracting Entity (CE) Operation start date
"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
"suppertime", -- Time supper service starts and ends. Data displayed as: H:MM – H:MM
"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
"pmsnacktime", -- Time afternoon snack service starts and ends. Data displayed as: H:MM – H:MM
"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
"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
"amsnacktime", -- Time morning snack service starts and ends. Data displayed as: H:MM – H:MM
"breakfasttime", -- Time breakfast service starts and ends. Data displayed as: H:MM – H:MM
"meal_types_served_b_reakfast", -- Type of meals served at the site during operation. Data displayed as: Breakfast/Lunch/Dinner/AM Snack/PM Snack; multiple entries separated by commas
"days_of_operation_s_m_t_w", -- 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/Closed-Enrolled in Needy Area/Closed-Enrolled in Non-Needy Area/Homeless (site is not a residential child care institution)/Open/Open Restricted
"sitesupervisor_emailaddress", -- Site contact phone number
"sitesupervisor_phonenumber", -- Site contact email address
"sitesupervisor_titleposition", -- Site contact title or position
"sitesupervisor_lastname", -- Site contact last name
"sitesupervisor_firstname", -- Site contact first name
"sitesupervisor_salutation", -- Honorific salutation for site contact. Optional entry. Format: Mr., Ms. Dr., etc.
"primaryauthorizedreprese_5", -- Program coordinator phone number
"primaryauthorizedreprese_4", -- Program coordinator email address
"primaryauthorizedreprese_3", -- Program coordinator title or position
"primaryauthorizedreprese_2", -- Program coordinator last name
"primaryauthorizedreprese_1", -- Program coordinator first name
"primaryauthorizedreprese", -- Honorific salutation for program coordinator. Optional entry for CE. Format: Mr., Ms. Dr., etc.
"ce_administrator_emailaddress", -- Program administrator email address
"ce_administrator_titleposition", -- Program administrator title or position
"ce_administrator_lastname", -- Program administrator last name
"ce_administrator_firstname", -- Program administrator first name
"ce_administrator_salutation", -- Honorific salutation for program administrator. Optional entry for CE. Format: Mr., Ms., Dr., etc.
"sitestreetaddresszipcode", -- Site street address, zip code
"sitestreetaddressstate", -- Site street address, state
"sitestreetaddresscity", -- Site street address, city
"sitestreetaddressstreet2", -- Site street address, line 2 (if applicable)
"sitestreetaddressstreet1", -- Site street address, line 1
"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
"cestreetaddressline1", -- Contracting Entity (CE) street address, line 1
"sitecounty", -- County in which the site is located
"cecounty", -- County in which the Contracting Entity (CE) is located
"countydistrictcode", -- County District Code for county in which Contracting Entity (CE) in located
"siteterminatedasofdate", -- Date that participation in this TDA nutrition program effectively ends for the site. Data displayed as: MM/DD/YYYY / (blank – not terminated). New field added for program year 2018-2019
"siteterminationstatus", -- Termination category for site that is no longer participating in this TDA nutrition program. Data for SFSP and SSO displayed as: Contracting Entity Closed /Self Cancelled/TDA cancelled/TDA Terminated(blank – not terminated). New field added for program year 2018-2019
"sitestatus", -- Site is eligible and/or participating in nutrition program. Data displayed as: Active/Inactive. New field added for program year 2018-2019
"sitename", -- Site name
"siteid", -- Identification number assigned to site within CE
"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). New field added for program year 2018-2019
"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). New field added for program year 2018-2019
"esc", -- Educational Service Center (ESC) region
"typeof_x_org", -- Type of organization the sponsor operates as. Data displayed as: Charter/Nonresidential Summer Camp/Private Nonprofit/Residential Camp/Public/School Food Authority/Unit of Government
"cename", -- Contracting Entity (CE) name
"ceid", -- Unique number assigned to Contracting Entity (CE) to identify organization as a program sponsor
"program", -- Educational institutions participating in School Nutrition Programs are eligible to participate in the Seamless Summer Option (SSO) or the Summer Food Service Program (SFSP). Private non-profit organizations are eligible to participate in SFSP only. Data is displayed as: SFSP/SSO.
"reporttype", -- Type of information being reported in the dataset
"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_dvbw_p2gv",
":@computed_region_vuzu_t7st",
":@computed_region_fd5q_j34z",
":@computed_region_ywmh_rrwq",
":@computed_region_hy99_5a2i",
":@computed_region_346f_s9gh",
":@computed_region_9y59_55ru",
":@computed_region_45pq_umjc",
":@computed_region_czj8_xg26",
":@computed_region_5xir_5pdr",
":@computed_region_59h5_km5p",
":@computed_region_de3d_j5mj",
"geolocation", -- Point data for latitude and longitude based on mappable site street address.
"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
"ce_administrator_phonenumber", -- Program administrator phone number
"cestreetaddressline2", -- Contracting Entity (CE) street address, line 2 (if applicable)
"ceapplicationcycle", -- Description of Contracting Entity (CE) application type based on program participation in previous program year. Data displayed as: Continuing/NewApp/Renewal. New field added for program year 2018-2019
"cestatus", -- Contracting Entity is eligible and/or participating in nutrition program. Data displayed as: Active/Inactive. New field added for program year 2018-2019
"tdaregion", -- Texas Department of Agriculture (TDA) service region
"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
FROM
"texas-gov/summer-meal-programs-all-summer-sites-contact-and-aj5s-8pui:latest"."summer_meal_programs_all_summer_sites_contact_and"
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-all-summer-sites-contact-and-aj5s-8pui 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-all-summer-sites-contact-and-aj5s-8pui: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-all-summer-sites-contact-and-aj5s-8pui" \
--handler-options '{
"domain": "data.texas.gov",
"tables": {
"summer_meal_programs_all_summer_sites_contact_and": "aj5s-8pui"
}
}'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-all-summer-sites-contact-and-aj5s-8pui is just another Postgres schema.