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_seamless_summer_option_sso table in this repository, by referencing it like:
"texas-gov/summer-meal-programs-seamless-summer-option-sso-3hpz-ajxk:latest"."summer_meal_programs_seamless_summer_option_sso"or in a full query, like:
SELECT
":id", -- Socrata column ID
"superintendenttitleposition", -- CE administrator/superintendent title or position
"sitestreetaddressline2", -- Site street address, line 2 (if applicable)
"countydistrictcode", -- County District Code for county in which Contracting Entity (CE) in located
"cename", -- Contracting Entity (CE) name
"sitetype", -- Site type description. Data displayed as: Camp/Closed/Open/Open Restricted
"sitestreetcity", -- Site street address, city
"siteid", -- Identification number assigned to site within CE
"pmsnacktime", -- Time afternoon snack service starts and ends. Data displayed as: H:MM – H:MM
"cemailingaddressline2", -- Contracting Entity (CE) mailing address, line 2 (if applicable)
"cemailingaddressstate", -- Contracting Entity (CE) mailing address, state
"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
":@computed_region_fd5q_j34z",
"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
"cestatus", -- Contracting Entity is eligible and/or participating in nutrition program. Data displayed as: Active/Inactive
"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
"sitestreetstate", -- Site street address, state
"reporttype", -- Type of information being reported in the dataset
":@computed_region_ywmh_rrwq",
":@computed_region_hy99_5a2i",
":@computed_region_346f_s9gh",
":@computed_region_9y59_55ru",
"superintendentsalutation", -- Honorific salutation for CE administrator/superintendent. Optional entry for CE. Format: Mr., Ms., Dr., etc.
"siteenddate", -- Operational end date for the site
"sitestreetaddressline1", -- Site street address, line 1
"breakfasttime", -- Time breakfast service starts and ends. Data displayed as: H:MM – H:MM
"childnutdirphone", -- Child Nutrition Director (CND) phone number
"childnutdiremail", -- Child Nutrition Director (CND) email address
"seamlesssummercontactphone", -- Summer program contact phone number
"ceid", -- Unique number assigned to Contracting Entity (CE) to identify organization as a program sponsor
"cemailingaddressline1", -- Contracting Entity (CE) mailing address, line 1
"cestreetaddresscity", -- Contracting Entity (CE) street address, city
"programyear", -- A program period for summer feeding programs is defined as mid-May through the end of August for the same calendar year.
"days_of_operation", -- 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
"childnutdirlastname", -- Child Nutrition Director (CND) last name
"childnutdirfirstname", -- Child Nutrition Director (CND) first name
"superintendentlastname", -- CE administrator/superintendent last name
"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
"suppertime", -- Time supper service starts and ends. Data displayed as: H:MM – H:MM
"cestreetaddresszipcode", -- Contracting Entity (CE) street address, zip code
"cestreetaddressline1", -- Contracting Entity (CE) street address, line 1
"cecounty", -- County in which the Contracting Entity (CE) is located
"superintendentfirstname", -- CE administrator/superintendent first name
"superintendentemail", -- CE administrator/superintendent email address
"cestreetaddressline2", -- Contracting Entity (CE) street address, line 2 (if applicable)
"seamlesssummercontactsal", -- Honorific salutation for summer program contact. Optional entry. Format: Mr., Ms. Dr., etc.
"cemailingaddresscity", -- Contracting Entity (CE) mailing address, city
"cemailingaddresszipcode", -- Contracting Entity (CE) mailing address, zip code
"seamlesssummercontactfirstname", -- Summer program contact first name
"seamlesssummercontactemail", -- Summer program contact email address
"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
"cestreetaddressstate", -- Contracting Entity (CE) street address, state
"siteterminationstatus", -- Termination category for site that is no longer participating in this TDA nutrition program. Data for SSO displayed as: Contracting Entity Closed /Self Cancelled/TDA cancelled/TDA Terminated(blank – not terminated). 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
"geocoded_column", -- Geo-location of site based on site street address for map visualization.
"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
"sitestatus", -- Site 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
"sitestreetzipcode", -- Site street address, zip code
"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
"esc", -- Educational Service Center (ESC) region
"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
"amsnacktime", -- Time morning snack service starts and ends. Data displayed as: H:MM – H:MM
"seamlesssummercontacttit", -- Summer program contact title or position
"seamlesssummercontactlastname", -- Summer program contact last name
"sitecounty", -- County in which the site is located
"sitename", -- Site name
"childnutdirtitleposition", -- Child Nutrition Director (CND) title or position
"superintendentphone", -- CE administrator/superintendent phone number
"childnutdirsalutation", -- Honorific salutation for Child Nutrition Director (CND). Optional entry for CE. Format: Mr., Ms. Dr., etc.
"typeofsnporg", -- Type of organization the sponsored site operates as. Data displayed as: Charter/Private/Public/RCCI (Residential Child Care Institution)
"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
"lunchtime", -- Time lunch 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
"meal_types_served", -- Type of meals served at the site during operation. Data displayed as: Breakfast/Lunch/Dinner/AM Snack/PM Snack; multiple entries separated by commas
"sitestartdate" -- Operational start date for the site
FROM
"texas-gov/summer-meal-programs-seamless-summer-option-sso-3hpz-ajxk:latest"."summer_meal_programs_seamless_summer_option_sso"
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-seamless-summer-option-sso-3hpz-ajxk 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-seamless-summer-option-sso-3hpz-ajxk: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-seamless-summer-option-sso-3hpz-ajxkCheckout 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-seamless-summer-option-sso-3hpz-ajxk:latestThis will download all the objects for the latest tag of texas-gov/summer-meal-programs-seamless-summer-option-sso-3hpz-ajxk 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-seamless-summer-option-sso-3hpz-ajxk: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-seamless-summer-option-sso-3hpz-ajxk: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-seamless-summer-option-sso-3hpz-ajxk is just another Postgres schema.