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 county_budgeted_revenues_by_type_by_fiscal_year table in this repository, by referencing it like:
"mydata-iowa-gov/county-budgeted-revenues-by-type-by-fiscal-year-2vm8-seah:latest"."county_budgeted_revenues_by_type_by_fiscal_year"or in a full query, like:
SELECT
":id", -- Socrata column ID
"total_resources", -- Total of all revenues and beginning balances.
"beginning_fund_balances", -- Estimated amount of balance in all funds as of July 1 of the fiscal year.
"total_revenues", -- Total of all revenues budgeted for the fiscal year.
"fixed_asset_sales", -- Estimated proceeds from the sale of assets during the budgeted fiscal year.
"general_long_term_debt", -- Estimated proceeds from issuance of long-term debt obligations during the fiscal year.
"operating_transfers_in", -- Estimated amount of transfers between funds during the fiscal year.
"subtotal_revenue", -- Subtotal of all revenues except Operating Transfers In, Long-Term Debt proceeds, and FIxed Asset Sales.
"miscellaneous", -- Estimated revenues to be received from contributions, deposits and refunds, sale of merchandise and fines.
"use_of_money_and_property", -- Estimated revenue to be received from interest on held cash balances and rents collected.
"licenses_and_permits", -- Estimated revenue from building structure, equipment and environmental licenses and permits.
"intergovernmental", -- Estimated revenues received from Federal, State, and other local government sources.
"other_county_taxes", -- All tax revenues received by the County which are not related to tax of owned property.
"delinquent_property_taxes", -- Taxes levied on property in previous years not received until the fiscal year shown.
"net_current_property_taxes", -- Amount of Property Taxes Levied on Property, less Uncollected Delinquent Taxes and Credits to Taxpayers.
"credits_to_taxpayers", -- Estimate of credit given to property tax payers on their tax statements and amount due. This is treated as a reduction of Taxes Levied on Property revenue.
"uncollected_delinquent_taxes", -- Estimate of taxes that will not be received during the fiscal year. This is treated as a reduction of Taxes Levied on Property revenue.
"taxes_levied_on_property", -- Amount of property taxes budgeted to be received from taxpayers during the fiscal year.
"county_name", -- Name of the county the budgeted revenues are related to.
"unique_line_id", -- Unique identifier for the line of data within the dataset.
"county_number", -- Number used to tract county level data.
"penalties_and_interest", -- Estimated revenue to be received from payment of penalties and interest.
"charges_for_services", -- Estimated revenue from fees paid for county provided goods and services.
"fiscal_year", -- Fiscal year which the budgeted revenues are associated with. Fiscal years run from July 1 to June 30.
"geocoded_column", -- Latitude and longitude for the center point of the county.
":@computed_region_3r5t_5243",
":@computed_region_wnea_7qqw",
":@computed_region_i9mz_6gmt",
":@computed_region_e7ym_nrbf",
":@computed_region_uhgg_e8y2"
FROM
"mydata-iowa-gov/county-budgeted-revenues-by-type-by-fiscal-year-2vm8-seah:latest"."county_budgeted_revenues_by_type_by_fiscal_year"
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/county-budgeted-revenues-by-type-by-fiscal-year-2vm8-seah 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 mydata-iowa-gov/county-budgeted-revenues-by-type-by-fiscal-year-2vm8-seah: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/county-budgeted-revenues-by-type-by-fiscal-year-2vm8-seahCheckout 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/county-budgeted-revenues-by-type-by-fiscal-year-2vm8-seah:latestThis will download all the objects for the latest tag of mydata-iowa-gov/county-budgeted-revenues-by-type-by-fiscal-year-2vm8-seah 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/county-budgeted-revenues-by-type-by-fiscal-year-2vm8-seah: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/county-budgeted-revenues-by-type-by-fiscal-year-2vm8-seah: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, mydata-iowa-gov/county-budgeted-revenues-by-type-by-fiscal-year-2vm8-seah is just another Postgres schema.