Query the Data Delivery Network

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

"cityofnewyork-us/covid19-expenditures-report-thut-5mdg:latest"."covid19_expenditures_report"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "contract_id", -- Unique identifier for the contract document in FMS
    "cap_id_desc", -- Brief description of the project.
    "vendor", -- The legal entity or payee (if available) for the expenditure.
    "date_of_exp", -- Date at which the expenditure is incurred
    "obj_code", -- Object Codes are part of the accounting structure on payment requests that represent the type of services that are being paid to a City agency's Vendor/Customer.
    "agy_code", -- Unique three-digit code representing each Agency in the City's Financial Management System (FMS).
    "exp_amount", -- Dollar amount transacted by the City within this expenditure
    "doc_id", -- Unique identifier for the expenditure document in FMS
    "agy_name", -- The name of the City agency incurring the cost.
    "fiscal_year", -- The Fiscal Year (June - July) that the cost is associated with.
    "u_a_code", -- Highest level measure of spending that has been authorized in the budget by the City Council for specific purposes,
    "u_a_desc", -- Brief description of the Unit of Appropriation
    "obj_desc", -- Brief description of the Object Code
    "exp_type", -- Identifies whether the cost is an Expense or Capital cost.
    "bc", -- Agency created code allocating funds and associating revenue within a Unit of Appropriation. For COVID-19 related costs, all Budget Codes must start with "CV".
    "bc_desc", -- Brief description of the Budget Code
    "proj_fund_source", -- The expected revenue source to be used to cover these costs, including both Federal, State, and City sources.
    "cap_id", -- For a Capital cost, the unique ID for the associated Capital Project.
    "obj_type", -- Identifies whether the cost is Personnel Service (PS) or Other Than Personnel Service (OTPS)
    "pub_dt" -- 8-digit number for date of publication
FROM
    "cityofnewyork-us/covid19-expenditures-report-thut-5mdg:latest"."covid19_expenditures_report"
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 cityofnewyork-us/covid19-expenditures-report-thut-5mdg with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.cityofnewyork.us. When you querycityofnewyork-us/covid19-expenditures-report-thut-5mdg: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)"

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.cityofnewyork.us, 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 \
  "cityofnewyork-us/covid19-expenditures-report-thut-5mdg" \
  --handler-options '{
    "domain": "data.cityofnewyork.us",
    "tables": {
        "covid19_expenditures_report": "thut-5mdg"
    }
}'

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, cityofnewyork-us/covid19-expenditures-report-thut-5mdg is just another Postgres schema.