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

"cityofnewyork-us/dob-after-hour-variance-permits-g76y-dcqj:latest"."dob_after_hour_variance_permits"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "residence_200ft", -- Indicates whether or not a residence is located within 200 feet of the address of the after hours variance
    "longitude",
    "latitude",
    "borough", -- A number to indicate the NYC borough where the proposed work will take place.
    "council_district",
    "nta",
    "workpermitnumber", -- The DOB work permit(s) associated with the after hours variance
    "job_number", -- The DOB job number(s) assigned when the applicant begins the application.
    "cbno", -- A number to indicate the NYC borough where the proposed work will take place.
    "variance_start_date_time", -- Date when the after hours variance initiates
    "streetname", -- The street name for the building owner's address.
    "housenumber", -- The house number for the building owner's address.
    "ahvpermitstatus", -- The status of the after hours variance
    "community_board",
    "ahv_permit_number", -- The DOB AHV Permit Number assigned when the after hours variance is issued
    "enclosed_work", -- Indicates whether or not the after hours variance applies to work being done in an enclosed building
    "census_tract",
    "variancetype", -- The type of variance issued (initial or renewal)
    "crane_use", -- Indicates whether or not the after hours variance involves use of a crane
    "bbl",
    "demolition", -- Indicates whether or not the after hours variance involves full or partial demolition
    "variance_end_date_time", -- Date when the after hours variance expires
    "reasonforvariance", -- The reason the after hours variance has been sought
    "bin" -- Building Identification Number assigned by Department of City Planning.
FROM
    "cityofnewyork-us/dob-after-hour-variance-permits-g76y-dcqj:latest"."dob_after_hour_variance_permits"
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/dob-after-hour-variance-permits-g76y-dcqj 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/dob-after-hour-variance-permits-g76y-dcqj: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/dob-after-hour-variance-permits-g76y-dcqj" \
  --handler-options '{
    "domain": "data.cityofnewyork.us",
    "tables": {
        "dob_after_hour_variance_permits": "g76y-dcqj"
    }
}'

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/dob-after-hour-variance-permits-g76y-dcqj is just another Postgres schema.