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 child_and_adult_care_food_programs_cacfp_centers table in this repository, by referencing it like:
"texas-gov/child-and-adult-care-food-programs-cacfp-centers-8rqi-6nkw:latest"."child_and_adult_care_food_programs_cacfp_centers"or in a full query, like:
SELECT
":id", -- Socrata column ID
"applicationeffectivedate", -- Date Contracting Entity (CE) is approved to begin program participation for program year.
"geocoded_column", -- Based on site street address
"foodservicevendorname", -- Name of food service vendor if site uses a food service contract
"foodservicecontract", -- Indicates whether site has a food service contract. Data displayed as: Y/N.
"mealservicemethod", -- Method used by site to serve meals. Data is displayed as: Unit (Cafeteria)/Family
"mealpreparationmethod", -- Method used by site to prepare meals. Data for CACFP Centers displayed as: Prepared on site/Prepared at Central Facility and Delivered/Contracted with a Public School/Purchased from a food service vendor/Other. Selection of multiple methods is possible.
"agerangeofparticipants", -- Age range of participants enrolled at site. Data displayed as: # Yrs # Mnths - # Yrs to # Mnths
"totalparticipantsenrolled", -- Total number of participants enrolled at the site in the calendar month preceding program application.
"paideligibleenrolled", -- Number of enrolled participants reported on the site application not eligible for free or reduced price meals in the calendar month preceding program application. New field added for program year 2018-2019
"reducedpriceeligibleenrolled", -- Number of participants eligible for reduced-price meals enrolled at the site in the calendar month preceding program application. New field added for program year 2018-2019
"freeeligibleenrolled", -- Number of participants eligible for free meals enrolled at the site in the calendar month preceding program application. New field added for program year 2018-2019
"sitelicensecapacity", -- If site is licensed, participant capacity as per site license
"sitelicensenumber", -- If site is licensed, license number
"at_riskonly", -- Site operates as an At-Risk center only. Data displayed as: Y/N
"at_riskafterschoolcarecenter", -- Site operates as an At-Risk afterschool care center (At-Risk). Data displayed as: Y/N
"headstart", -- Site operates as a Head Start center. Data displayed as: Y/N
"emergencyshelter", -- Site operates as an emergency shelter. Data displayed as: Y/N
"outsideschoolhours", -- Site operates as an outside school hours center. Data displayed as: Y/N
"childcare", -- Site operates as a child care center (CCC). Data displayed as: Y/N
"adultdaycare", -- Site operates as an adult day care (ADC) center. Same as "Adult Care Center" in datasets prior to 2018-2019. Data displayed as: Y/N
"siteaffiliation", -- The relationship the site has with its Contracting Entity (CE) sponsor. Affiliated sites are part of the CE organization. Unaffiliated sites are not part of the CE organization. Data displayed as: Affiliated/Unaffiliated
"taxstatusdescription", -- Explanation if “Other” was selected for Site Tax Status
"taxstatus", -- Tax status site files under. Data displayed as: For Profit/Non Profit/Other/Public
"sitecontactphone", -- Site contact phone number. Site contact is the person in charge of this center on a daily basis.
"sitecontactemail", -- Site contact email address. Site contact is the person in charge of this center on a daily basis.
"sitecontacttitleposition", -- Site contact title or position. Site contact is the person in charge of this center on a daily basis.
"sitecontactlastname", -- Site contact last name. Site contact is the person in charge of this center on a daily basis.
"sitecontactfirstname", -- Site contact first name. Site contact is the person in charge of this center on a daily basis.
"sitecontactsalutation", -- Honorific salutation for site contact. Optional entry. Format: Mr., Ms. Dr., etc.
"ceadministratorphone", -- CE administrator phone number
"ceadministratoremail", -- CE administrator email address
"ceadministratortitleposition", -- CE administrator title or position
"ceadministratorlastname", -- CE administrator last name
"ceadministratorfirstname", -- CE administrator first name
"ceadministratorsalutation", -- Honorific salutation for CE administrator. Optional entry for CE. Format: Mr., Ms., Dr., etc.
"sitemailingaddresszipcode", -- Site mailing address, zip code
"sitemailingaddressstate", -- Site mailing address, state
"sitemailingaddresscity", -- Site mailing address, city
"sitemailingaddressline2", -- Site mailing address, line 2 (if applicable)
"sitemailingaddressline1", -- Site mailing address, line 1
"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 county in which Contracting Entity (CE) in located (if applicable)
"siteapplicationcycle", -- Description of site application type based on program participation in previous program year. Date displayed as: NewApp/Continuing
"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
"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
"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. 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 CACFP Centers displayed as: Independent Center/Sponsor of Affiliated & Unaffiliated Sites/Sponsor of Affiliated Sites/Sponsor of Unaffiliated Sites.
"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
"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 Child and Adult Care Food Programs (Centers and DCH) is defined as October 1 of one year through September 30 of the following year.
":@computed_region_hy99_5a2i",
":@computed_region_346f_s9gh",
":@computed_region_9y59_55ru",
":@computed_region_fd5q_j34z",
":@computed_region_ywmh_rrwq"
FROM
"texas-gov/child-and-adult-care-food-programs-cacfp-centers-8rqi-6nkw:latest"."child_and_adult_care_food_programs_cacfp_centers"
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/child-and-adult-care-food-programs-cacfp-centers-8rqi-6nkw 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/child-and-adult-care-food-programs-cacfp-centers-8rqi-6nkw: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/child-and-adult-care-food-programs-cacfp-centers-8rqi-6nkw" \
--handler-options '{
"domain": "data.texas.gov",
"tables": {
"child_and_adult_care_food_programs_cacfp_centers": "8rqi-6nkw"
}
}'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/child-and-adult-care-food-programs-cacfp-centers-8rqi-6nkw is just another Postgres schema.