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

"cityofnewyork-us/buildings-subject-to-hpd-jurisdiction-kj4p-ruqc:latest"."buildings_subject_to_hpd_jurisdiction"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "censustract", -- Geographic area defined by the U.S. Census Bureau for the various decennial censuses 
    "boro", -- Boro code (1 = Manhattan, 2 = Bronx, 3 = Brooklyn, 4 = Queens, 5 = Staten Island) 
    "highhousenumber", -- Address information for the building 
    "recordstatus", -- "The numeric value of the status of this building code (1 = Active, 2 = Inactive, 3 = Pending)" 
    "housenumber", -- Address information for the building 
    "buildingid", -- Unique identifier of building 
    "dobbuildingclass", -- Stores DoB building classification codes as augmented by HPD for other than Multiple Dwellings (see DoBBuildingClass below) 
    "lowhousenumber", -- Address information for the building 
    "managementprogram", -- Contains the current active management program which determines who is responsible for the management of this building 
    "recordstatusid", -- Unique number for record status
    "registrationid", -- Multiple dwelling registration number, used by HPD in the master building file to identify a building 
    "legalstories", -- Number of legal stories in building 
    "block", -- Tax block for building 
    "boroid", -- Unique number identifying a borough
    "legalclassb", -- The number of rooms in a multiple dwelling without individual baths and kitchens 
    "legalclassa", -- The number of apartments in a multiple dwelling 
    "bin", -- DCP Building Identification Number for building 
    "lot", -- Tax lot for building 
    "communityboard", -- Unique number identifying a Community District/Board, which is a political geographical area within a borough of the City of NY 
    "streetname", -- Address information for the building 
    "dobbuildingclassid", -- Unique number identifying DoB Building Class Code
    "lifecycle", -- The stage in the building life cycle 
    "zip" -- Address information for the building 
FROM
    "cityofnewyork-us/buildings-subject-to-hpd-jurisdiction-kj4p-ruqc:latest"."buildings_subject_to_hpd_jurisdiction"
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/buildings-subject-to-hpd-jurisdiction-kj4p-ruqc 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/buildings-subject-to-hpd-jurisdiction-kj4p-ruqc: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/buildings-subject-to-hpd-jurisdiction-kj4p-ruqc" \
  --handler-options '{
    "domain": "data.cityofnewyork.us",
    "tables": {
        "buildings_subject_to_hpd_jurisdiction": "kj4p-ruqc"
    }
}'

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/buildings-subject-to-hpd-jurisdiction-kj4p-ruqc is just another Postgres schema.