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_meal_reimbursement table in this repository, by referencing it like:
"texas-gov/school-nutrition-programs-meal-reimbursement-kde6-bnft:latest"."school_nutrition_programs_meal_reimbursement"or in a full query, like:
SELECT
":id", -- Socrata column ID
"snackreimbursement", -- Total snack meal reimbursement for claim month
"snacktotal", -- Total number of snack meals served at site for claim month
"breakfasttotal", -- Total breakfasts served by site for claim month
"lunchadp", -- Average Daily Participation (ADP) for lunch. Calculated as the number of lunch meals served at the site in claim month divided by the number of lunch service days at the site in claim month.
"breakfastservedredc", -- Number of reduced price breakfast meals served at site for claim month
"milkdays", -- Number of days milk was served as part of the Special Milk Program (SMP) at site for claim month
"snackdays", -- Number of days snack meals were served at site for claim month
"milkservedpaid", -- Total number of Special Milk Program (SMP) paid milk portions served at site for claim month
"ceid", -- Unique number assigned by TDA to Contracting Entity (CE) to identify organization as program sponsor
"snackadp", -- Average Daily Participation (ADP) for snacks. Calculated as the number of snacks served at the site in claim month divided by the number of snack service days at the site in claim month.
"siteid", -- Identification number assigned to site under CE sponsorship
"countydistrictcode", -- County District Code for Contracting Entity (CE)
"paideligqty", -- Number of participants enrolled at site that are not eligible for free or reduced price meals in claim month.
"enrollmentqty", -- Number of children or participants enrolled at site for claim month
"breakfastservedfree", -- Number of free breakfast meals served at site for claim month
"breakfastservedpaid", -- Number of paid breakfast meals served at site for claim month
"snacksservedfree", -- Total number of free snack meals served at site for claim month
"breakfastreimbursement", -- Total breakfast reimbursement for claim month
"snacksservedredc", -- Total number of reduced price snack meals served at site for claim month
"reporttype", -- Type of information being reported in the dataset
"lunchreimbursement", -- Total lunch reimbursement for claim month
"milkservedreduced", -- Total number of Special Milk Program (SMP) reduced price milk portions served at site for claim month
"totalreimbursement", -- Total federal meal reimbursement for site for claim month
"sitecounty", -- County in which the site is located
"milkadp", -- Average Daily Participation (ADP) for milk. Calculated as the number of half pint milks served at the site in claim month divided by the number of milk service days at the site in claim month.
"cecounty", -- County in which the Contracting Entity (CE) is located
"cename", -- Contracting Entity (CE) name; district name
"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
"sitename", -- Site name; school name
"tdaregion", -- Texas Department of Agriculture (TDA) service region
"lunchservedredc", -- Total number of reduced price lunch meals served at site for claim month
"totalmeals_snacks", -- Sum of BreakfastTotal, LunchTotal, and SnackTotal. New field beginning Oct 2022.
"lunchtotal", -- Total lunches served by site for claim month
"milkservedfree", -- Total number of Special Milk Program (SMP) free milk portions served at site for claim month
"esc", -- Educational Service Center (ESC) region
"lunchdays", -- Number of days lunch meals were served at site for claim month
"redceligqty", -- Number of participants enrolled at site that are eligible for reduced price meals in claim month.
"breakfastadp", -- Average Daily Participation (ADP) for breakfast. Calculated as the number of breakfast meals served at the site in claim month divided by the number of breakfast service days at the site in claim month.
"milkreimbursement", -- Total Special Milk Program (SMP) milk reimbursement for claim month
"lunchservedfree", -- Total number of free lunch meals served at site for claim month
"snacksservedpaid", -- Total number of paid snack meals served at site for claim month
"freeeligqty", -- Number of participants enrolled at site that are eligible for free meals in claim month.
"breakfastdays", -- Number of days breakfast meals were served at site for claim month
"programyear", -- A program year for School Nutrition Programs is defined as July 1 of one year through June 30 of the following year.
"milktotal", -- Total number of Special Milk Program (SMP) milk portions served at site for claim month
"lunchservedpaid", -- Total number of paid lunch meals served at site for claim month
"typeoforg", -- Type of organization the Contracting Entity (CE) operates as within a specific nutrition program. Data for School Nutrition Programs and SSO displayed as: Charter/Private/Public/RCCI (Residential Child Care Institution).
"claimdate" -- Month and year being reported for reimbursement of meals served
FROM
"texas-gov/school-nutrition-programs-meal-reimbursement-kde6-bnft:latest"."school_nutrition_programs_meal_reimbursement"
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-meal-reimbursement-kde6-bnft 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-meal-reimbursement-kde6-bnft: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-meal-reimbursement-kde6-bnftCheckout 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-meal-reimbursement-kde6-bnft:latestThis will download all the objects for the latest tag of texas-gov/school-nutrition-programs-meal-reimbursement-kde6-bnft 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-meal-reimbursement-kde6-bnft: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-meal-reimbursement-kde6-bnft: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-meal-reimbursement-kde6-bnft is just another Postgres schema.