ny-gov/schedule-of-debt-for-industrial-development-dtk8-znku
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 schedule_of_debt_for_industrial_development table in this repository, by referencing it like:

"ny-gov/schedule-of-debt-for-industrial-development-dtk8-znku:latest"."schedule_of_debt_for_industrial_development"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "end_amount_total", --  Amount of debt outstanding at the end of the fiscal year. This is a calculated field and consists of the Begin Amount Total plus the New Debt Issuance, less the Amount Retired.  This amount is specific to the type of debt indicated in the "Type of Debt" field.  This field is blank when the authority reported having no outstanding debt.
    "outstanding_debt", -- N indicates that the authority reported having no outstanding debt. This field is blank when the authority reported having outstanding debt.
    "type_of_debt", -- Indicates the type of debt issued. Authorities may select any of the following types of debt: State Guaranteed, State Supported, State Contingent Obligation, State Moral Obligation, Other State‐Funded, Authority Debt ‐ General Obligation, Authority Debt – Revenue, Authority Debt – Other, Conduit Debt. Definitions for the different types of debt can be found in the Overview document, found by selecting the "About" tab at the right. This field is blank when the authority reported having no outstanding debt.
    "authority_name", -- Name of the Public Authority
    "debt_program", -- Name of the program for which debt was issued.  The name is specific to the type of debt indicated in the "Type of Debt" field.  This field is blank for Type of Debt identified by the Authority as Authority Debt - Revenue.  This field is blank when the authority reported having no outstanding debt.
    "begin_amount_total", -- Amount of debt outstanding at the beginning of the fiscal year. This amount is specific to the type of debt indicated in the "Type of Debt" field.  This is a pre-populated field and consists of the End Amount Total from the prior fiscal year.  This field is blank when the authority reported having no outstanding debt.
    "fiscal_year_end_date", -- Date of Fiscal Year end for the Authority
    "new_debt_issuance", --  Amount of debt issued during the fiscal year. This amount is specific to the type of debt indicated in the "Type of Debt" field.  This field is blank when the authority reported having no outstanding debt.
    "amount_retired" -- Amount of debt retired during the fiscal year. This amount is specific to the type of debt indicated in the "Type of Debt" field.  This field is blank when the authority reported having no outstanding debt.
FROM
    "ny-gov/schedule-of-debt-for-industrial-development-dtk8-znku:latest"."schedule_of_debt_for_industrial_development"
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/schedule-of-debt-for-industrial-development-dtk8-znku with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.ny.gov. When you queryny-gov/schedule-of-debt-for-industrial-development-dtk8-znku: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 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 \
  "ny-gov/schedule-of-debt-for-industrial-development-dtk8-znku" \
  --handler-options '{
    "domain": "data.ny.gov",
    "tables": {
        "schedule_of_debt_for_industrial_development": "dtk8-znku"
    }
}'

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, ny-gov/schedule-of-debt-for-industrial-development-dtk8-znku is just another Postgres schema.