health-data-ny-gov/vital-statistics-deaths-by-resident-county-region-eyur-mqqm
Icon for Socrata external plugin

Query the Data Delivery Network

Query the DDN

The 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 vital_statistics_deaths_by_resident_county_region table in this repository, by referencing it like:

"health-data-ny-gov/vital-statistics-deaths-by-resident-county-region-eyur-mqqm:latest"."vital_statistics_deaths_by_resident_county_region"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "region", -- New York City (NYC) or Rest of State (ROS)
    "selected_cause_of_death", -- A high level aggregation of the cause of death of the resident.  The cause of death reported in these data files is the underlying cause classified according to the tenth revision of the International Classification of Diseases (ICD, 10th revision) adopted by New York State in 1999.
    "deaths", -- The number of deaths among New York State residents for a calendar year.
    "county_name", -- The NYS county where the resident lived at the time of their death. *Region codes are represented in the county code column. New York State consists of two registration areas, New York City and Rest of State. New York City (NYC) includes the five counties of Bronx, Kings (Brooklyn), New York (Manhattan), Queens and Richmond (Staten Island); the remaining 57 counties comprise Rest of State.
    "year" -- The calendar year in which the deaths took place.
FROM
    "health-data-ny-gov/vital-statistics-deaths-by-resident-county-region-eyur-mqqm:latest"."vital_statistics_deaths_by_resident_county_region"
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 health-data-ny-gov/vital-statistics-deaths-by-resident-county-region-eyur-mqqm with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at health.data.ny.gov. When you queryhealth-data-ny-gov/vital-statistics-deaths-by-resident-county-region-eyur-mqqm:latest on the DDN, we "mount" the repository using the socrata mount handler. The mount handler proxies your SQL query to the upstream data source, translating it from SQL to the relevant language (in this case SoQL).

We also cache query responses on the DDN, but we run the DDN on multiple nodes so a CACHE_HIT is only guaranteed for subsequent queries that land on the same node.

Query Your Local Engine

Install Splitgraph Locally
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 (like this repository), 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, where the author has pushed Splitgraph Images to the repository, you can "clone" and/or "checkout" the data using sgr cloneand sgr checkout.

Mounting Data

This repository is an external repository. It's not hosted by Splitgraph. It is hosted by health.data.ny.gov, and Splitgraph indexes it. This means it is not an actual Splitgraph image, so you cannot use sgr clone to get the data. Instead, you can use the socrata adapter with the sgr mount command. Then, if you want, you can import the data and turn it into a Splitgraph image that others can clone.

First, install Splitgraph if you haven't already.

Mount the table with sgr mount

sgr mount socrata \
  "health-data-ny-gov/vital-statistics-deaths-by-resident-county-region-eyur-mqqm" \
  --handler-options '{
    "domain": "health.data.ny.gov",
    "tables": {
        "vital_statistics_deaths_by_resident_county_region": "eyur-mqqm"
    }
}'

That's it! Now you can query the data in the mounted table like any other Postgres table.

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, health-data-ny-gov/vital-statistics-deaths-by-resident-county-region-eyur-mqqm is just another Postgres schema.