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_child table in this repository, by referencing it like:
"texas-gov/child-and-adult-care-food-programs-cacfp-child-5tnh-rpur:latest"."child_and_adult_care_food_programs_cacfp_child"or in a full query, like:
SELECT
":id", -- Socrata column ID
"snackpmreimbursement", -- Total afternoon snack reimbursement for claim month
"lunchreimbursement", -- Total lunch meal reimbursement for claim month
"ntsnackservedpaid", -- Number of paid evening snacks served at site in claim month
"ntsnackdays", -- Number of days evening snacks served at site for claim month
"supperservedpaid", -- Number of paid supper meals served at site in claim month
"supperservedfree", -- Number of free supper meals served at site in claim month
"supperadp", -- Average Daily Participation (ADP) for supper meals. Calculated as number of supper meals served at site in claim month divided by number of site supper service days for site in claim month
"supperdays", -- Number of days supper meals served at site for claim month
"pmsnackservedredc", -- Number of reduced price afternoon snacks served at site in claim month
"pmsnackadp", -- Average Daily Participation (ADP) for afternoon snacks. Calculated as calculated by number of afternoon snack served at site in claim month divided by number of afternoon snack service days at the site in claim month
"pmsnacktotal", -- Number of afternoon snacks served at site for the claim month
"lunchtotal", -- Number of lunch meals served at site for claim month
"lunchdays", -- Number of days lunch was served at site for claim month
"amsnackservedredc", -- Number of reduced price morning snacks served at site in claim month
"amsnackservedfree", -- Number of free morning snacks served at site in claim month
"amsnacktotal", -- Number of morning snacks served at site for the claim month
"amsnackdays", -- Number of days morning snacks were served at site for claim month
"breakfastservedfree", -- Number of free breakfast meals served at site for 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.
"paideligqty", -- Number of participants enrolled at site not approved for free or reduced price meals for claim month
"enrollmentqty", -- Number of participants enrolled at site for claim month
"cecounty", -- County in which the Contracting Entity (CE) is located
"sitename", -- Site name
"cename", -- Contracting Entity (CE) name
"snackamreimbursement", -- Total morning snack reimbursement for claim month
"ntsnackservedredc", -- Number of reduced price evening snacks served at site in claim month
"ntsnackadp", -- Average Daily Participation (ADP) for evening snacks. Calculated as number of evening snack meals served at site in claim month divided by number of evening snack service days at site in claim month
"ntsnacktotal", -- Number of evening snacks served at site for the claim month
"supperservedredc", -- Number of reduced price supper meals served at site in claim month
"pmsnackservedfree", -- Number of free afternoon snacks served at site in claim month
"lunchservedredc", -- Number of reduced price lunch meals served at site for claim month
"lunchservedfree", -- Number of free lunch meals served at 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.
"breakfastservedpaid", -- Number of paid breakfast meals served at site for claim month
"breakfastservedredc", -- Number of reduced price breakfast meals served at site for claim month
"redceligqty", -- Number of participants enrolled at site at site approved for reduced price meals for claim month
"claimdate", -- Month and year for which meals were reported by the site for reimbursement.
"sitecounty", -- County in which the site is located
"siteid", -- Number assigned to identify site within CE
"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
"ceid", -- Unique number assigned to Contracting Entity (CE) to identify organization as a CACFP sponsor
"amsnackadp", -- Average Daily Participation (ADP) for morning snacks. Calculated as calculated by number of morning snacks served at site in claim month divided by number of morning snack service days at the site in claim month
"snackntreimbursement", -- Total evening snack reimbursement for claim month
"reporttype", -- Type of information being reported in the dataset
"totalreimbursement", -- Total federal meal reimbursement for site for claim month, including Cash-in-Lieu of Commodities.
"supperreimbursement", -- Total supper meal reimbursement for claim month
"breakfastreimbursement", -- Total breakfast meal reimbursement for claim month
"ntsnackservedfree", -- Number of free evening snacks served at site in claim month
"suppertotal", -- Number of supper meals served at site in the claim month
"pmsnackservedpaid", -- Number of paid afternoon snacks served at site in claim month
"pmsnackdays", -- Number of days afternoon snacks served at site for claim month
"lunchservedpaid", -- Number of paid lunch meals served at site for claim month
"amsnackservedpaid", -- Number of paid morning snacks served at site in claim month
"breakfasttotal", -- Number of breakfast meals served at site for the claim month
"breakfastdays", -- Number of days breakfast meals served at site for claim month
"freeeligqty", -- Number of participants enrolled at site approved for free meals for claim month
"affiliation", -- Affiliation refers to the relationship the site has with its CE sponsor. Affiliated sites are part of the Contracting Entity (CE) organization. Unaffiliated sites are not part of the Contracting Entity (CE) organization. Data displayed as: Affiliated/Unaffiliated
"esc", -- Educational Service Center (ESC) region
"typeoforg", -- Type of organization the Contracting Entity (CE) operates as. Data displayed as: Independent Center/Sponsor of Affiliated & Unaffiliated Sites/Sponsor of Affiliated Sites/Sponsor of Unaffiliated Sites/(blank)
"programyear", -- A program year for Child and Adult Care Food Programs (CACFP) is defined as October 1 of one year through September 30 of the following year.
"tdaregion" -- Texas Department of Agriculture (TDA) service region
FROM
"texas-gov/child-and-adult-care-food-programs-cacfp-child-5tnh-rpur:latest"."child_and_adult_care_food_programs_cacfp_child"
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-child-5tnh-rpur 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/child-and-adult-care-food-programs-cacfp-child-5tnh-rpur: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/child-and-adult-care-food-programs-cacfp-child-5tnh-rpurCheckout 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/child-and-adult-care-food-programs-cacfp-child-5tnh-rpur:latestThis will download all the objects for the latest tag of texas-gov/child-and-adult-care-food-programs-cacfp-child-5tnh-rpur 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/child-and-adult-care-food-programs-cacfp-child-5tnh-rpur: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/child-and-adult-care-food-programs-cacfp-child-5tnh-rpur: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/child-and-adult-care-food-programs-cacfp-child-5tnh-rpur is just another Postgres schema.