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 new_debt_issuance_for_state_authorities table in this repository, by referencing it like:
"ny-gov/new-debt-issuance-for-state-authorities-83xh-6x8i:latest"."new_debt_issuance_for_state_authorities"or in a full query, like:
SELECT
":id", -- Socrata column ID
"refunding_amount", -- Total refunding amount. This field is blank when the Authority reported having no new debt issuances.
"bond_closing_date", -- The date of bond issuance. This field is blank when the Authority reported having no new debt issuances.
"cost_of_issuance", -- The expenses associated with the sale of a new issue of municipal securities, including such items as printing, legal and rating agency fees and others. In certain cases, the underwriter's discount may be considered one of the costs of issuance. This field is blank when the Authority reported having no new debt issuances.
"statement_url", -- URL to the official statement for the reported new debt issuance. This field is blank when the Authority reported having no new debt issuances or if the Authority reported they did not prepare an official statement. This field is only applicable for State Authorities.
"total_amount", -- Calculated field summing the Refunding Amount and New Amount. This field is blank when the Authority reported having no new debt issuances.
"true_interest_cost", -- The effective rate of interest compounded semi-annually on the amount of bonds issued, plus the cost of issuance, expressed as a percentage. This information should be available from the bond counsel, or available from the official statement. This field is blank when the Authority reported having no new debt issuances.
"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. This field is blank when the Authority reported having no new debt issuances.
"program", -- Name of the program for which debt was issued. The program is specific to the "Type of Debt" field and correlates to the enacted New York State Budget. This field is only required for State Guaranteed, State Supported, State Contingent Obligation, State Moral Obligation, or Other State-Funded debt. This field is blank when the Authority reported having no new debt issuances or if the debt type is not State-backed debt.
"project_name", -- Name of project requiring debt issuance. This field is blank when the Authority reported having no new debt issuances.
"cusip_number", -- A unique nine-character alphanumeric identifier assigned by The Committee on Uniform Securities Identification Procedures (CUSIP) to identify most securities, including U.S. government and municipal bonds. This field is blank when the Authority reported having no new debt issuances. This field is only applicable for State Authorities.
"taxable_status", -- Indicates the taxable status of the bond. Authorities may select from the following: Taxable, Tax Exempt, Alternative Minimum Tax Exempt. This field is blank when the Authority reported having no new debt issuances. This field is only applicable for State Authorities.
"issue_process", -- Indicates the method of sale used for the new issuance. Authorities may select from the following: Competitive or Negotiated. This field is blank when the Authority reported having no new debt issuances.
"term_years", -- The length of the bond (in years) until it matures. This field is blank when the Authority reported having no new debt issuances.
"authority_name", -- Name of the Public Authority
"pacb_project_approval_number", -- Project number provided by the Public Authorities Control Board (PACB). The PACB reviews the revenue sufficiency of projects prior to approving the debt issued by select State Authorities, as required under Public Authorities Law, Sections 50 and 51. This field is blank when the Authority reported having no new debt issuances or if the Authority did not provide information. This field is only applicable for State Authorities.
"fiscal_year_end_date", -- Date of Fiscal Year end for the Authority
"issued_debt_obligations", -- Indicates whether the authority reported issuing new debt in a fiscal year. Authorities that report no outstanding debt during the fiscal year are not required to answer this question.
"interest_type", -- Indicates whether the interest rate is fixed or variable. This field is blank when the Authority reported having no new debt issuances.
"new_amount" -- New amount of debt being issued. This field is blank when the Authority reported having no new debt issuances.
FROM
"ny-gov/new-debt-issuance-for-state-authorities-83xh-6x8i:latest"."new_debt_issuance_for_state_authorities"
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/new-debt-issuance-for-state-authorities-83xh-6x8i 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/new-debt-issuance-for-state-authorities-83xh-6x8i: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
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/new-debt-issuance-for-state-authorities-83xh-6x8i" \
--handler-options '{
"domain": "data.ny.gov",
"tables": {
"new_debt_issuance_for_state_authorities": "83xh-6x8i"
}
}'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/new-debt-issuance-for-state-authorities-83xh-6x8i is just another Postgres schema.