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 school_nutrition_programs_contact_information_and table in this repository, by referencing it like:
"texas-gov/school-nutrition-programs-contact-information-and-3369-uxbk:latest"."school_nutrition_programs_contact_information_and"or in a full query, like:
SELECT
":id", -- Socrata column ID
"geocoded_column", -- Geolocation data based on site address.
"operationenddate", -- End date of operations for the sponsor or district for the program year. New field added for program year 2018-2019
"operationstartdate", -- Start date of operations for the sponsor or district for the program year. New field added for program year 2018-2019
"grade12", -- Grades at this site – twelfth (12th) grade. Data displayed as: Y/(blank)
"grade11", -- Grades served at this site – eleventh (11th) grade. Data displayed as: Y/(blank)
"grade10", -- Grades served at this site – tenth (10th) grade. Data displayed as: Y/(blank)
"grade9", -- Grades served at this site – ninth (9th) grade. Data displayed as: Y/(blank)
"grade8", -- Grades served at this site – eighth (8th) grade. Data displayed as: Y/(blank)
"grade7", -- Grades served at this site – seventh (7th) grade. Data displayed as: Y/(blank)
"grade6", -- Grades served at this site – sixth (6th) grade. Data displayed as: Y/(blank)
"grade5", -- Grades served at this site – fifth (5th) grade. Data displayed as: Y/(blank)
"grade4", -- Grades served at this site – fourth (4th) grade. Data displayed as: Y/(blank)
"grade3", -- Grades served at this site – third (3rd) grade. Data displayed as: Y/(blank)
"grade2", -- Grades served at this site – second (2nd) grade. Data displayed as: Y/(blank)
"grade1", -- Grades served at this site – first (1st) grade. Data displayed as: Y/(blank)
"gradekinder", -- Grades served at this site – Kindergarten. Data displayed as: Y/(blank)
"gradeprek", -- Grades served at this site – Pre-kindergarten. Data displayed as: Y/(blank)
"gradeheadstart", -- Grades served at this site – Head Start. Data displayed as: Y/(blank)
"gradeearlyeducation", -- Grades served at this site – early education. Data displayed as: Y/(blank)
"snackpricing", -- Method of snack meal pricing employed by site during the program year
"lunchpricing", -- Method of lunch meal pricing employed by site during the program year
"breakfastpricing", -- Method of breakfast meal pricing employed by site during the program year
"provision2", -- Participation of site in Provision 2 (P2) during the program year. Data displayed as: Y/N
"cep", -- Participation of site in the Community Eligible Provision (CEP) during the program year. Data displayed as: Y/N
"siteisp", -- Identified Student Percentage (ISP) reported April of the previous program year. ISP describes the percent of students enrolled who are directly certified to receive free meals without household application. Contributes to determining eligibility of a site or group of sites for electing CEP meal pricing.
"areaeligiblesnack", -- Participation of site in the Area Eligible Snack during the program year. Data displayed as: Y/N
"universalfreebreakfast", -- Participation of site in the Universal Free Breakfast (UB) during the program year. Data displayed as: Y/N
"severeneedbreakfast", -- Participation of site in the Severe Needs Breakfast Program (SNB) during the program year. Data displayed as: Y/N
"ffvpapproved", -- Participation of site in the Fresh Fruits and Vegetable Program (FFVP) during the program year. Data displayed as: Y/N
"specialmilkprogram", -- Participation of site in the Special Milk Program (SMP) during the program year. Data displayed as: Y/N
"afterschoolcareprogram", -- Site participates in the After School Care Program (ASCP) during the program year. Data displayed as: Y/N
"nationalschoollunchprogram", -- Participation of site in the National School Lunch Program (NSLP) during the program year. Data displayed as: Y/N
"schoolbreakfastprogram", -- Participation of site in the School Breakfast Program (SBP) during the program year. Data displayed as, Y/N
"vendmealstosfa", -- CE organization vends meals to a School Food Authority (SFA). Data displayed as: Y/N
"mealspurchasedfromvendor", -- CE organization purchases meals/snacks from a vendor other than a School Food Authority (SFA). Data displayed as: Y/N
"mealspurchasedfromsfa", -- CE organization purchases meals from a School Food Authority (SFA). Data displayed as: Y/N
"managedbyfsmc", -- School nutrition program contracts with a Food Service Management Company (FSMC). FSMC details can be found in the School Nutrition Program – Food Service Management Company Information dataset. Data displayed as: Y/N
"childnutdirphone", -- Child Nutrition Director (CND) phone number
"childnutdiremail", -- Child Nutrition Director (CND) email address
"childnutdirtitleposition", -- Child Nutrition Director (CND) title or position
"childnutdirlastname", -- Child Nutrition Director (CND) last name
"childnutdirfirstname", -- Child Nutrition Director (CND) first name
"childnutdirsalutation", -- Honorific salutation for Child Nutrition Director (CND). Optional entry for CE. Format: Mr., Ms. Dr., etc.
"superintendentphone", -- CE administrator/superintendent phone number
"superintendentemail", -- CE administrator/superintendent email address
"superintendenttitleposition", -- CE administrator/superintendent title or position
"superintendentlastname", -- CE administrator/superintendent last name
"superintendentfirstname", -- CE administrator/superintendent first name
"superintendentsalutation", -- Honorific salutation for Superintendent. 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
"sitestreetaddressline2", -- Site street address, line 2 (if applicable)
"sitestreetaddressline1", -- 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
"cestreetaddressline2", -- Contracting Entity (CE) street address, line 2 (if applicable)
"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 Contracting Entity (CE).
"siteapplicationcycle", -- Description of site application type based on program participation in previous program year. Date displayed as: NewApp/Renewal. New field added for program year 2018-2019
"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 CACFP Centers, SNP, 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
"covidmealsite", -- COVID-19 Meal Site indicator, Indicates whether site operated under USDA flexibilities offered in response to the COVID-19 pandemic. Data displayed as: Yes/No.
"sitename", -- Site name; school name
"siteid", -- Identification number assigned to site under CE sponsorship
"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
"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
"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
"esc", -- Educational Service Center (ESC) region
"typeoforg", -- Type of organization the Contracting Entity (CE) operates as within a specific nutrition program. Data for School Nutrition Programs displayed as: Charter/Private/Public/RCCI (Residential Child Care Institution).
"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/Other
"cename", -- Contracting Entity (CE) name; sponsor or district name
"ceid", -- Unique number assigned by TDA to Contracting Entity (CE) to identify organization as program sponsor
"reporttype", -- Type of information being reported in the dataset
"programyear", -- A program year for School Nutrition Programs is defined as July 1 of one year through June 30 of the following year.
":@computed_region_fd5q_j34z", -- This column was automatically created in order to record in what polygon from the dataset 'Counties' (fd5q-j34z) the point in column 'geocoded_column' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
":@computed_region_ywmh_rrwq", -- This column was automatically created in order to record in what polygon from the dataset 'Texas Congressional Districts' (ywmh-rrwq) the point in column 'geocoded_column' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
":@computed_region_hy99_5a2i", -- This column was automatically created in order to record in what polygon from the dataset 'Texas Senate Districts' (hy99-5a2i) the point in column 'geocoded_column' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
":@computed_region_346f_s9gh", -- This column was automatically created in order to record in what polygon from the dataset 'Texas House Districts' (346f-s9gh) the point in column 'geocoded_column' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
":@computed_region_9y59_55ru", -- This column was automatically created in order to record in what polygon from the dataset 'Texas Councils of Government' (9y59-55ru) the point in column 'geocoded_column' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"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
FROM
"texas-gov/school-nutrition-programs-contact-information-and-3369-uxbk:latest"."school_nutrition_programs_contact_information_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/school-nutrition-programs-contact-information-and-3369-uxbk 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/school-nutrition-programs-contact-information-and-3369-uxbk: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/school-nutrition-programs-contact-information-and-3369-uxbk" \
--handler-options '{
"domain": "data.texas.gov",
"tables": {
"school_nutrition_programs_contact_information_and": "3369-uxbk"
}
}'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/school-nutrition-programs-contact-information-and-3369-uxbk is just another Postgres schema.