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 township_revenues_expenditures_cash_balances
table in this repository, by referencing it like:
"mydata-iowa-gov/township-revenues-expenditures-cash-balances-7v7k-5pb4:latest"."township_revenues_expenditures_cash_balances"
or in a full query, like:
SELECT
":id", -- Socrata column ID
"end_bal_total", -- Estimated ending cash balance of all funds on June 30 of the fiscal year
"expend_total", -- Budgeted expenditure of all funds for fiscal year
"oth_rec_total", -- Budgeted non-tax receipts of the all funds for fiscal year
"tax_rev_total", -- Budgeted property tax levy revenues of all funds for fiscal year
"end_bal_other", -- Estimated ending cash balance of other/miscellaneous fund on June 30 of the fiscal year
"expend_other", -- Budgeted expenditure of the other/miscellaneous fund for fiscal year
"oth_rec_other", -- Budgeted non-tax receipts of the other/miscellaneous fund for fiscal year
"beg_bal_other", -- Budgeted cash balance of other/miscellaneous fund on July 1st
"end_bal_fire_ems", -- Estimated ending cash balance of fire/EMS fund on June 30 of the fiscal year
"expend_fire_ems", -- Budgeted expenditure of the fire/EMS fund for fiscal year
"tax_rev_fire_ems", -- Budgeted property tax revenues of fire/EMS levy for fiscal year
"beg_bal_fire_ems", -- Budgeted cash balance of fire/EMS fund on July 1st
"expend_tort", -- Budgeted expenditure of the tort liability fund for fiscal year
"oth_rec_tort", -- Budgeted non-tax receipts of the tort liability fund for fiscal year
"tax_rev_tort", -- Budgeted property tax revenues of tort liability levy for fiscal year
"beg_bal_tort", -- Budgeted cash balance of tort liability fund on July 1st
"end_bal_litigation", -- Estimated ending cash balance of litigation fund on June 30 of the fiscal year
"expend_litigation", -- Budgeted expenditure of the litigation fund for fiscal year
"oth_rec_litigation", -- Budgeted non-tax receipts of the litigation fund for fiscal year
"beg_bal_litigation", -- Budgeted cash balance of litigation fund on July 1st
"end_bal_library", -- Estimated ending cash balance of library fund on June 30 of the fiscal year
"expend_library", -- Budgeted expenditure of the library fund for fiscal year
"tax_rev_library", -- Budgeted property tax revenues of library levy for fiscal year
"beg_bal_library", -- Budgeted cash balance of library fund on July 1st
"oth_rec_twp_hall_repairs", -- Budgeted non-tax receipts of the township hall repairs fund for fiscal year
"tax_rev_twp_hall_repairs", -- Budgeted property tax revenues of owned cemetery levy for fiscal year
"beg_bal_twp_hall_repairs", -- Budgeted cash balance of township hall repairs fund on July 1st
"end_bal_twp_hall", -- Estimated ending cash balance of township hall fund on June 30 of the fiscal year
"expend_twp_hall", -- Budgeted expenditure of the township hall fund for fiscal year
"oth_rec_twp_hall", -- Budgeted non-tax receipts of the township hall fund for fiscal year
"tax_rev_twp_hall", -- Budgeted property tax revenues of township hall levy for fiscal year
"beg_bal_twp_hall", -- Budgeted cash balance of township hall fund on July 1st
"expend_non_owned_cem", -- Budgeted expenditure of the non-owned cemetery fund for fiscal year
"oth_rec_non_owned_cem", -- Budgeted non-tax receipts of the non-owned cemetery fund for fiscal year
"tax_rev_non_owned_cem", -- Budgeted property tax revenues of non-owned cemetery levy for fiscal year
"end_bal_owned_cem", -- Estimated ending cash balance of owned cemetery fund on June 30 of the fiscal year
"oth_rec_owned_cem", -- Budgeted non-tax receipts of the owned cemetery fund for fiscal year
"tax_rev_owned_cem", -- Budgeted property tax revenues of owned cemetery levy for fiscal year
"beg_bal_owned_cem", -- Budgeted cash balance of owned cemetery fund on July 1st
"township_name", -- Name of the Township
"twp_code", -- Code used for tracking township data
"location", -- Latitude and longitude of the township.
"end_bal_tort", -- Estimated ending cash balance of tort liability fund on June 30 of the fiscal year
"end_bal_twp_hall_repairs", -- Estimated ending cash balance of township hall repairs fund on June 30 of the fiscal year
"expend_twp_hall_repairs", -- Budgeted expenditure of the township hall repairs fund for fiscal year
"end_bal_non_owned_cem", -- Estimated ending cash balance of non-owned cemetery fund on June 30 of the fiscal year
"expend_owned_cem", -- Budgeted expenditure of the owned cemetery fund for fiscal year
"beg_bal_total", -- Budgeted cash balance of all funds on July 1st
"oth_rec_fire_ems", -- Budgeted non-tax receipts of the fire/EMS fund for fiscal year
"oth_rec_library", -- Budgeted non-tax receipts of the library fund for fiscal year
"beg_bal_non_owned_cem", -- Budgeted cash balance of non-owned cemetery fund on July 1st
"county_name", -- County in which the township resides
"fiscal_year", -- Fiscal year of data beginning July 1st
"unique_line_id", -- Unique ID for the data contained in this line of the dataset.
"tax_rev_litigation" -- Budgeted property tax revenues of litigation levy for fiscal year
FROM
"mydata-iowa-gov/township-revenues-expenditures-cash-balances-7v7k-5pb4:latest"."township_revenues_expenditures_cash_balances"
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 mydata-iowa-gov/township-revenues-expenditures-cash-balances-7v7k-5pb4
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 mydata-iowa-gov/township-revenues-expenditures-cash-balances-7v7k-5pb4: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 mydata-iowa-gov/township-revenues-expenditures-cash-balances-7v7k-5pb4
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 mydata-iowa-gov/township-revenues-expenditures-cash-balances-7v7k-5pb4:latest
This will download all the objects for the latest
tag of mydata-iowa-gov/township-revenues-expenditures-cash-balances-7v7k-5pb4
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 mydata-iowa-gov/township-revenues-expenditures-cash-balances-7v7k-5pb4: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 mydata-iowa-gov/township-revenues-expenditures-cash-balances-7v7k-5pb4: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, mydata-iowa-gov/township-revenues-expenditures-cash-balances-7v7k-5pb4
is just another Postgres schema.