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-jezb-2499:latest"."school_nutrition_programs_contact_information_and"or in a full query, like:
SELECT
":id", -- Socrata column ID
"operationenddate", -- End date of operations for the sponsor or district for the program year. 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
"grade4", -- Grades served at this site – fourth (4th) grade. Data displayed as: Y/(blank)
"provision2", -- Participation of site in Provision 2 (P2) 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
"countydistrictcode", -- County District Code for county in which site in located
"childnutdirlastname", -- Child Nutrition Director (CND) last name
"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
"cestreetaddresszipcode", -- Contracting Entity (CE) street address, zip code
"sitestreetaddressstate", -- Site street address, state
"reporttype", -- Type of information being reported in the dataset
":@computed_region_fd5q_j34z",
"childnutdirsalutation", -- Honorific salutation for Child Nutrition Director (CND). Optional entry for CE. Format: Mr., Ms. Dr., etc.
"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)
"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)
"severneedbreakfast", -- Participation of site in the Severe Needs Breakfast Program (SNB) 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
"breakfastpricing", -- Method of breakfast meal pricing employed by site during the program year
"areaeligiblesnack", -- Participation of site in the Area Eligible Snack 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
"superintendentsalutation", -- Honorific salutation for CE administrator/superintendent. Optional entry for CE. Format: Mr., Ms., Dr., etc.
"cemailingaddresszipcode", -- Contracting Entity (CE) mailing address, zip code
"cestreetaddressstate", -- Contracting Entity (CE) street address, state
"siteterminationstatus", -- Termination category for site that is no longer participating in this TDA nutrition program. Data for SNP displayed as: Contracting Entity Closed /Self Cancelled/TDA cancelled/TDA Terminated(blank – not terminated). New field added for program year 2018-2019
"programyear", -- A program year for school nutrition programs is defined as July 1 of one year through June 30 of the following year.
"grade10", -- Grades served at this site – tenth (10th) grade. Data displayed as: Y/(blank)
"snackpricing", -- Method of snack meal pricing employed by site during the program year
"grade1", -- Grades served at this site – first (1st) grade. Data displayed as: Y/(blank)
"grade6", -- Grades served at this site – sixth (6th) grade. Data displayed as: Y/(blank)
":@computed_region_ywmh_rrwq",
":@computed_region_hy99_5a2i",
":@computed_region_346f_s9gh",
":@computed_region_9y59_55ru",
"ceid", -- Unique number assigned to Contracting Entity (CE) to identify organization as a school nutrition program sponsor
"cename", -- Contracting Entity (CE) name
"esc", -- Educational Service Center (ESC) region
"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
"siteid", -- Identification number assigned to site within CE
"sitename", -- Site name
"sitestatus", -- Site is eligible and/or participating in nutrition program. Data displayed as: Active/Inactive. New field added for program year 2018-2019
"sitecounty", -- County in which the site is located
"cestreetaddressline1", -- Contracting Entity (CE) street address, line 1
"cestreetaddresscity", -- Contracting Entity (CE) street address, city
"cemailingaddressline1", -- Contracting Entity (CE) mailing address, line 1
"cemailingaddressline2", -- Contracting Entity (CE) mailing address, line 2 (if applicable)
"cemailingaddressstate", -- Contracting Entity (CE) mailing address, state
"sitestreetaddressline1", -- Site street address, line 1
"sitestreetaddressline2", -- Site street address, line 2 (if applicable)
"sitestreetaddresszipcode", -- Site street address, zip code
"superintendentfirstname", -- CE administrator/superintendent first name
"childnutdirfirstname", -- Child Nutrition Director (CND) first name
"childnutdirphone", -- Child Nutrition Director (CND) phone number
"managedbyfsmc", -- School nutrition program contracts with a Food Service Management Company (FSMC). FSMC details can be found in our School Nutrition Program – Food Service Management Company Information dataset. Data displayed as: Y/N
"mealspurchasedfromsfa", -- CE organization purchases meals from a School Food Authority (SFA). Data displayed as: Y/N
"purchasemealsfromvendoro", -- CE organization purchases meals/snacks from a vendor other than a School Food Authority (SFA). 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
"cep", -- Participation of site in the Community Eligible Provision (CEP) during the program year. Data displayed as: Y/N
"lunchpricing", -- Method of lunch meal pricing employed by site during the program year
"grade5", -- Grades served at this site – fifth (5th) grade. Data displayed as: Y/(blank)
"grade8", -- Grades served at this site – eighth (8th) grade. Data displayed as: Y/(blank)
"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
"grade9", -- Grades served at this site – ninth (9th) grade. Data displayed as: Y/(blank)
"cecounty", -- County in which the Contracting Entity (CE) is located
"cestreetaddressline2", -- Contracting Entity (CE) street address, line 2 (if applicable)
"cemailingaddresscity", -- Contracting Entity (CE) mailing address, city
"sitestreetaddresscity", -- Site street address, city
"superintendentlastname", -- CE administrator/superintendent last name
"superintendenttitleposition", -- CE administrator/superintendent title or position
"superintendentemail", -- CE administrator/superintendent email address
"superintendentphone", -- CE administrator/superintendent phone number
"childnutdirtitleposition", -- Child Nutrition Director (CND) title or position
"childnutdiremail", -- Child Nutrition Director (CND) email address
"schoolbreakfastprogram", -- Participation of site in the School Breakfast Program (SBP) during the program year. Data displayed as, Y/N
"afterschoolcareprogram", -- Participation of site in the After School Care Program (ASCP) during the program year. Data displayed as: Y/N
"site_isp", -- Identified Student Percentage (ISP) as per April of the previous program year. Contributes to determining eligibility of a site or group of sites for electing CEP meal pricing.
"gradeearlyeducation", -- Grades served at this site – early education. Data displayed as: Y/(blank)
"gradekinder", -- Grades served at this site – Kindergarten. Data displayed as: Y/(blank)
"grade2", -- Grades served at this site – second (2nd) grade. Data displayed as: Y/(blank)
"grade3", -- Grades served at this site – third (3rd) grade. Data displayed as: Y/(blank)
"grade7", -- Grades served at this site – seventh (7th) grade. Data displayed as: Y/(blank)
"operationstartdate", -- Start date of operations for the sponsor or district for the program year. 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
"tdaregion", -- Texas Department of Agriculture (TDA) service region
"typeoforg", -- Type of organization the sponsored site operates as. Data 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/Government Agency/Private Non-Profit Organization/Other
"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.
FROM
"texas-gov/school-nutrition-programs-contact-information-and-jezb-2499: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-jezb-2499 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/school-nutrition-programs-contact-information-and-jezb-2499: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/school-nutrition-programs-contact-information-and-jezb-2499Checkout 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/school-nutrition-programs-contact-information-and-jezb-2499:latestThis will download all the objects for the latest tag of texas-gov/school-nutrition-programs-contact-information-and-jezb-2499 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/school-nutrition-programs-contact-information-and-jezb-2499: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/school-nutrition-programs-contact-information-and-jezb-2499: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/school-nutrition-programs-contact-information-and-jezb-2499 is just another Postgres schema.