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 food_distribution_program_fdp_entitlements_school table in this repository, by referencing it like:
"texas-gov/food-distribution-program-fdp-entitlements-school-eccj-yc7p:latest"."food_distribution_program_fdp_entitlements_school"or in a full query, like:
SELECT
":id", -- Socrata column ID
"dodfreshdeduction", -- Amount of entitlement CE has dedicated to Department of Defense (DOD) Fresh Fruits and Vegetables Program (FFVP)
"warehouse", -- TDA-contracted warehouse that receives, briefly stores, and delivers USDA Foods to schools during the program year.
"bonusallocations", -- Value of USDA Foods received that did not draw down from Beginning Entitlement
"foodservicedirectorphone", -- Program Contract Contact - Food Service Director phone number
"totalbeginningentitlement", -- Current funds (entitlement) allotted to CE for USDA Foods during program year.
"entitlementremaining", -- Amount of entitlement funds remaining at time of report run
"processingreservedused", -- Amount of entitlement CE has dedicated for processing raw commodities for program year
"county", -- County the CE resides in
"processingreservedremaining", -- Amount of entitlement funds that are unused or uncommitted for processing at time of report
"combinedvaluetrueentitlementremaining", -- Sum of Processing Reserved Remaining and Entitlement Remaining
"cename", -- Contracting Entity (CE) name
"reporttype", -- Type of information being reported in the dataset
"entitlementused", -- Amount of entitlement utilized for filled requests for Processing, Department of Defense (DOD) Fresh Fruits and Vegetables Program (FFVP), regular USDA Foods (Brown Box), and Farm to School
"adminadjustments", -- Manual adjustments to entitlements made by the state
"programyear", -- A program year for School Nutrition Programs (SNP) is defined as July 1 of one year through June 30 of the following year.
"processingcoops", -- Affiliate cooperative assisting CEs in further processing of raw commodities to finished end products.
"foodservicedirectoraddresszipcode", -- Program Contract Contact - Food Service Director address zip code
"ceid", -- Unique number assigned by TDA to Contracting Entity (CE) to identify organization as program sponsor
"unfilledrequests", -- Amount of entitlement not filled by regular USDA Foods (Brown Box) and Farm to School
"ruralorurbancode", -- Geographic location description of the participating CE. Data displayed as: Rural/Urban
"foodservicedirectorname", -- Program Contract Contact - Food Service Director name
"foodservicedirectoremail", -- Program Contract Contact - Food Service Director email address
"foodservicedirectoraddressline2", -- Program Contract Contact - Food Service Director address line 2
"foodservicedirectoraddresscity", -- Program Contract Contact - Food Service Director address city
"entitlementallocations", -- Amount of entitlement utilized for filled requests for regular USDA Foods (Brown Box) and Farm to School
"foodservicedirectoraddressline1", -- Program Contract Contact - Food Service Director address line 1
"foodservicedirectoraddressstate" -- Program Contract Contact - Food Service Director address state
FROM
"texas-gov/food-distribution-program-fdp-entitlements-school-eccj-yc7p:latest"."food_distribution_program_fdp_entitlements_school"
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/food-distribution-program-fdp-entitlements-school-eccj-yc7p 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/food-distribution-program-fdp-entitlements-school-eccj-yc7p: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/food-distribution-program-fdp-entitlements-school-eccj-yc7pCheckout 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/food-distribution-program-fdp-entitlements-school-eccj-yc7p:latestThis will download all the objects for the latest tag of texas-gov/food-distribution-program-fdp-entitlements-school-eccj-yc7p 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/food-distribution-program-fdp-entitlements-school-eccj-yc7p: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/food-distribution-program-fdp-entitlements-school-eccj-yc7p: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/food-distribution-program-fdp-entitlements-school-eccj-yc7p is just another Postgres schema.