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 personal_income_tax_filers_summary_dataset_1_major
table in this repository, by referencing it like:
"ny-gov/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv:latest"."personal_income_tax_filers_summary_dataset_1_major"
or in a full query, like:
SELECT
":id", -- Socrata column ID
"tax_liability", -- Amount of NYS tax liability. May be negative due to refundable credits. The tax liability reflects the tax due (Tax Before Credits plus other NYS taxes), after nonrefundable and refundable credits. Negative values represent a refund. For Full‐Year Nonresident and Part‐Year Resident returns, this amount reflects NYS tax after allocation based on the ratio of New York‐source to federal‐source NYAGI.
"tax_liability_status", -- Status of Tax Liability: Taxable, Non‐Taxable, or All Returns. Taxable return has any amount of positive tax liability. Non‐Taxable return has no or zero tax liability, or a negative tax liability resulting from refundable credits. All Returns combines the Taxable and Non‐Taxable returns.
"place_of_residence", -- Name of the New York State County, State or Country of Residence Includes: “Other Places‐ NYS Resident” means Full‐Yr. Resident returns that could not be classified by county. “Other Places‐ Nonresident” means Full‐Yr. Nonresident unclassified returns, or with NY addresses; includes APO/FPO. “All Othr Countries” means Countries outside the USA, other than those reported that year. “All Places” combines all Places of Residence.
"nys_residency_status", -- Status of NYS Residency: Full‐Year Resident, Full‐Year Nonresident, Part‐Year Resident, or All Filers. Full‐Year Resident is a resident of New York State for the entire tax year. Full‐Year Nonresident is a not a resident for the entire year. Part‐Year Resident changes from a resident to a nonresident, or from a nonresident to a resident, during the tax year. All Filers combines the above three residency statuses.
"number_of_returns", -- The number of returns filed. Note: Married filing joint returns count as one.
"number_filing_married_joint", -- The number of returns with Filing Status “Married Joint”
"notes", -- “d/” ‐ Tax Law secrecy provisions prohibit the disclosure of the data; it means that the specific data blanked‐out in the following columns of that record have a value but could not be reported. The “Number of Returns” field determines whether or not the dollar‐amount of data can be disclosed in that row. See the Limitations section of the Overview on these notes: “1/” ‐ The data in two Filing Status fields for Full‐Year Nonresidents, except for Totals, is not reported. “2/” ‐ The data for Full‐Year Nonresidents and Part‐Year Residents on components of income, modifications, and deductions, except for Totals, is not reported. “3/” ‐ The data for Full‐Year Nonresidents and Part‐Year Residents in the highest three income ranges, except for Totals, is not reported. “4/” ‐ The data for modifications, except for Totals, is not reported.
"federal_amount_of_ny_adjusted_gross_income", -- Amount of federal‐source NYAGI (New York Adjusted Gross Income). May be negative. For Full‐Year Nonresident and Part‐Year resident returns, this amount includes both non‐New York income and New York‐ source income; the amount computed in column one on the form IT‐203, page 2. For Full‐Year Resident returns, the Federal and NYS Amounts of New York Adjusted Gross Income are equal.
"new_york_state_amount_of_ny_adjusted_gross_income", -- Amount of New York‐source NYAGI (New York Adjusted Gross Income). May be negative. The amount of federal adjusted gross income earned or received during the income year after certain modifications and before the subtraction of either the standard or itemized deductions, and dependent exemptions. For Full‐Year Nonresident and Part‐Year resident returns, the amount computed in column two on the form IT‐203, page 2. For Full‐Year Resident returns, the Federal and NYS Amounts of New York Adjusted Gross Income are equal.
"country", -- Name of Country “All” for all countries in “All Places”
"sort_on_statuses", -- Sort Order on Tax Liability Status and NYS Residency Status
"tax_year", -- Tax Year
"county", -- Name of New York State County Same as the “Place of Residence” field, except for Full‐ Year Nonresidents, which includes: o “All” for all counties of other states in USA o “Not Applicable” for countries outside USA
"number_filing_head_of_household", -- The number of returns with Filing Status “Head of Household”
"sort_on_place", -- Sort Order on Place of Residence
"number_filing_single", -- The number of returns filed with Filing Status “Single”
"state", -- Name of State
"number_filing_married_separate_or_widow_widower" -- The number of returns with Filing Status “Married Separate” or “Widow/Widower”
FROM
"ny-gov/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv:latest"."personal_income_tax_filers_summary_dataset_1_major"
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/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv
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 ny-gov/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv: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/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv
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 ny-gov/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv:latest
This will download all the objects for the latest
tag of ny-gov/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv
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/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv: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/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv: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, ny-gov/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv
is just another Postgres schema.