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 total_income_and_tax_liability_by_place_of table in this repository, by referencing it like:
"ny-gov/total-income-and-tax-liability-by-place-of-nacg-rg66:latest"."total_income_and_tax_liability_by_place_of"or in a full query, like:
SELECT
":id", -- Socrata column ID
"resident_type", -- Type of resident: Full-Year Resident, Full-Year Nonresident, Part-Year Nonresident
"average_ny_agi_of_nontaxable_returns", -- Average New York Adjusted Gross Income from non-taxable return filings
"average_tax_of_taxable_returns", -- Average Tax Liability from taxable return filings. Note: for Full-Year Nonresidents the data may not be available.
"average_ny_agi_of_taxable_returns", -- Average New York Adjusted Gross Income from taxable return filings
"average_tax_of_all_returns", -- Average Tax Liability from all return filings
"tax_liability_of_nontaxable_returns_in_thousands", -- Tax Liability from non-taxable return filings. Note: for tax years prior to 2011 the data may not be available. ** Includes refundable tax credits
"ny_agi_of_taxable_returns_in_thousands", -- New York Adjusted Gross Income from taxable return filings. * New York Adjusted Gross Income on resident tax forms and Federal source New York Adjusted Gross Income (includes non-New York income) on non-resident tax forms
"number_of_taxable_returns", -- Count of the number of taxable return filings (note: married filing joint returns count as one)
"ny_agi_of_all_returns_in_thousands", -- New York Adjusted Gross Income from return filings. * New York Adjusted Gross Income on resident tax forms and Federal source New York Adjusted Gross Income (includes non-New York income) on non-resident tax forms
"state", -- Name of State
"country", -- Name of Country +++ Includes other foreign countries ++++ Includes unclassified and individuals filing a nonresident tax return but containing a New York address
"tax_year", -- Tax year
"disclosure", -- Identifies whether the data in the next 9 columns have a value, but is not reported. d/ - Tax Law secrecy provisions prohibit the disclosure of the data
"place_of_residence", -- Name of the New York State County, State or Country of Residence Note: for Full-Year Nonresidents, the data may not be consistently available. + Resident returns that could not be classified by county ++ Includes resident tax returns with an out-of-state address +++ Includes other foreign countries ++++ Includes unclassified and individuals filing a nonresident tax return but containing a New York address.
"county", -- Name of New York State County. + Resident returns that could not be classified by county. ++ Includes resident tax returns with an out-of-state address.
"number_of_all_returns", -- Count of the number of return filings (note: married filing joint returns count as one)
"tax_liability_of_all_returns_in_thousands", -- Tax Liability from return filings. ** Includes refundable tax credits
"tax_liability_of_taxable_returns_in_thousands", -- Tax Liability from taxable return filings. Note: for Full-Year Nonresidents the data may not be available.
"number_of_nontaxable_returns", -- Count of the number of non-taxable return filings (note: married filing joint returns count as one)
"ny_agi_of_nontaxable_returns_in_thousands", -- New York Adjusted Gross Income from non-taxable return filings
"average_ny_agi_of_all_returns", -- Average New York Adjusted Gross Income from all return filings
"county_sort_order" -- Sort Order on Place of Residence
FROM
"ny-gov/total-income-and-tax-liability-by-place-of-nacg-rg66:latest"."total_income_and_tax_liability_by_place_of"
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 ny-gov/total-income-and-tax-liability-by-place-of-nacg-rg66 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 ny-gov/total-income-and-tax-liability-by-place-of-nacg-rg66: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 ny-gov/total-income-and-tax-liability-by-place-of-nacg-rg66Checkout 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 ny-gov/total-income-and-tax-liability-by-place-of-nacg-rg66:latestThis will download all the objects for the latest tag of ny-gov/total-income-and-tax-liability-by-place-of-nacg-rg66 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 ny-gov/total-income-and-tax-liability-by-place-of-nacg-rg66: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 ny-gov/total-income-and-tax-liability-by-place-of-nacg-rg66: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, ny-gov/total-income-and-tax-liability-by-place-of-nacg-rg66 is just another Postgres schema.