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-ixpn-g9tj:latest"."summer_meal_programs_all_summer_sites_contact_and"
or in a full query, like:
SELECT
":id", -- Socrata column ID
"sitestreetaddresscity", -- Site street address, city
"progrcoordinatorphone", -- Program coordinator phone number. Program Coordinator is the Child Nutrition Director for SSO participants and SFSP Contact for SFSP participants.
"progrcoordinatoremail", -- Program coordinator email address. Program Coordinator is the Child Nutrition Director for SSO participants and SFSP Contact for SFSP participants.
"progrcoordinatortitleposition", -- Program coordinator title or position. Program Coordinator is the Child Nutrition Director for SSO participants and SFSP Contact for SFSP participants.
"progrcoordinatorlastname", -- Program coordinator last name. Program Coordinator is the Child Nutrition Director for SSO participants and SFSP Contact for SFSP participants.
"operationstartdate", -- Date Contracting Entity (CE) has been approved to begin operations for the program year.
":@computed_region_ji3u_dqif",
"sitecontactsalutation", -- Honorific salutation for site contact. Optional entry. Format: Mr., Ms. Dr., etc.
"progrcoordinatorfirstname", -- Program coordinator first name. Program Coordinator is the Child Nutrition Director for SSO participants and SFSP Contact for SFSP participants.
"programyear", -- A program period for summer meal programs is defined as mid-May through the end of August for the same calendar year.
"progrcoordinatorsalutation", -- Honorific salutation for program coordinator. Optional entry for CE. Format: Mr., Ms. Dr., etc.
"progradministratorphone", -- Program administrator phone number. Program Administrator is the Superintendent for SSO participants and Primary Authorized Representative for SFSP participants.
"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
"reporttype", -- Type of information being reported in the dataset
"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.
":@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 'geolocation_data' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"progradministratoremail", -- Program administrator email address. Program Administrator is the Superintendent for SSO participants and Primary Authorized Representative for SFSP participants.
":@computed_region_de3d_j5mj",
"ceid", -- Unique number assigned to Contracting Entity (CE) to identify organization as a program sponsor
":@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 'geolocation_data' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"sitestartdate", -- Operational start date for the site
"sitecontactphone", -- Site contact phone number. Site Contact is the Seamless Summer Contact for SSO participants and Site Supervisor for SFSP participants.
":@computed_region_59h5_km5p",
"cename", -- Contracting Entity (CE) name
"sitecontactemail", -- Site contact email address. Site Contact is the Seamless Summer Contact for SSO participants and Site Supervisor for SFSP participants.
"operationenddate", -- Date Contracting Entity (CE) has identified as the end of operations for the program year.
"jun_aug_claims", -- Indicator that site provided summer meal service as determined by approved claims submitted for reimbursement. Y/N
"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
"typeoforg", -- 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
"esc", -- Educational Service Center (ESC) region
"tdaregion", -- Texas Department of Agriculture (TDA) service region
"cestatus", -- Contracting Entity is eligible and/or participating in nutrition program. Data displayed as: Active/Inactive.
"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).
"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).
"ceapplicationcycle", -- Description of Contracting Entity (CE) application type based on program participation in previous program year. Data displayed as: Continuing/NewApp/Renewal.
":@computed_region_dvbw_p2gv",
"siteid", -- Identification number assigned to site within CE
"sitename", -- Site name
":@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 'geolocation_data' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"covidmealsite", -- COVID-19 Meal Site indicator. Indicates whether site is operating under USDA flexibilities offered in response to the COVID-19 pandemic. Data displayed as: Yes/No.
"sitestatus", -- Site is eligible and/or participating in nutrition program. Data displayed as: Active/Inactive.
"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).
"siteterminatedasofdate", -- Date that participation in this TDA nutrition program effectively ends for the site. Data displayed as: MM/DD/YYYY / (blank – not terminated).
"countydistrictcode", -- County District Code for county in which Contracting Entity (CE) in located
"cecounty", -- County in which the Contracting Entity (CE) is located
"progradministratortitlep", -- Program administrator title or position. Program Administrator is the Superintendent for SSO participants and Primary Authorized Representative for SFSP participants.
"sitecounty", -- County in which the site is located
":@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 'geolocation_data' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"cestreetaddressline1", -- Contracting Entity (CE) street address, line 1
"progradministratorlastname", -- Program administrator last name. Program Administrator is the Superintendent for SSO participants and Primary Authorized Representative for SFSP participants.
"cestreetaddressline2", -- Contracting Entity (CE) street address, line 2 (if applicable)
"cestreetaddresscity", -- Contracting Entity (CE) street address, city
"cestreetaddressstate", -- Contracting Entity (CE) street address, state
"cestreetaddresszipcode", -- Contracting Entity (CE) street address, zip code
"cemailingaddressline1", -- Contracting Entity (CE) mailing address, line 1
"progradministratorfirstname", -- Program administrator first name. Program Administrator is the Superintendent for SSO participants and Primary Authorized Representative for SFSP participants.
"cemailingaddressline2", -- Contracting Entity (CE) mailing address, line 2 (if applicable)
"progradministratorsalutation", -- Honorific salutation for program administrator. Optional entry for CE. Format: Mr., Ms., Dr., etc.
"siteenddate", -- Operational end date for the site
"cemailingaddresscity", -- Contracting Entity (CE) mailing address, city
":@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 'geolocation_data' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"sitecontactfirstname", -- Site contact first name. Site Contact is the Seamless Summer Contact for SSO participants and Site Supervisor for SFSP participants.
"geolocation", -- Point data for latitude and longitude based on mappable site street address.
"sitecontacttitleposition", -- Site contact title or position. Site Contact is the Seamless Summer Contact for SSO participants and Site Supervisor for SFSP participants.
"cemailingaddressstate", -- Contracting Entity (CE) mailing address, state
"sitecontactlastname", -- Site contact last name. Site Contact is the Seamless Summer Contact for SSO participants and Site Supervisor for SFSP participants.
"oct_may_claims", -- Indicator that site used SSO or SFSP as an approved emergency measure to provide meals during the school year as determined by approved claims submitted for reimbursement. Y/N
"cemailingaddresszipcode", -- Contracting Entity (CE) mailing address, zip code
"sitestreetaddressline1", -- Site street address, line 1
"sitestreetaddressline2", -- Site street address, line 2 (if applicable)
"sitestreetaddresszipcode", -- Site street address, zip code
"sitestreetaddressstate" -- Site street address, state
FROM
"texas-gov/summer-meal-programs-all-summer-sites-contact-and-ixpn-g9tj: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-ixpn-g9tj
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; sgr
can 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 clone
and sgr checkout
.
Cloning Data
Because texas-gov/summer-meal-programs-all-summer-sites-contact-and-ixpn-g9tj: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-all-summer-sites-contact-and-ixpn-g9tj
Checkout 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-all-summer-sites-contact-and-ixpn-g9tj:latest
This will download all the objects for the latest
tag of texas-gov/summer-meal-programs-all-summer-sites-contact-and-ixpn-g9tj
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-all-summer-sites-contact-and-ixpn-g9tj: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-all-summer-sites-contact-and-ixpn-g9tj:latest
This 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-all-summer-sites-contact-and-ixpn-g9tj
is just another Postgres schema.