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


or in a full query, like:

    ":id", -- Socrata column ID
    "category", -- Category of the nomination. Most nominations are simply as a "Front Yards in Bloom" nomination. Other specific categories include the "Natural Front Yard" (started 2000) and "Edible Front Yard" (started 2009). Nominations may be assigned to either of thes
    "ward", -- Ward where the nominated address is located. Wards as defined in the 2010 municipal election.
    "neighbourhood", -- Neighbourhood (according to the City of Edmonton) where this address is located.
    "quadrant", -- Mailing quadrant of the nominated address. This does not describe the general quadrant of the address, but specifically the mailing address.
    "year", -- Year of Front Yards in Bloom program that the nomination was made. Nominations begin in April and deadline is early July. Dataset includes all nominations from 2006 and forward. Only top addresses are available prior to 2006.
    "address", -- Address that is nominated. Addresses are submitted by nominators, and human errors are possible.
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 edmonton-ca/front-yards-in-bloom-nominations-1999-2013-scjj-9qzz with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.edmonton.ca. When you queryedmonton-ca/front-yards-in-bloom-nominations-1999-2013-scjj-9qzz: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.edmonton.ca, 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 \
  "edmonton-ca/front-yards-in-bloom-nominations-1999-2013-scjj-9qzz" \
  --handler-options '{
    "domain": "data.edmonton.ca",
    "tables": {
        "front_yards_in_bloom_nominations_1999_2013": "scjj-9qzz"

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, edmonton-ca/front-yards-in-bloom-nominations-1999-2013-scjj-9qzz is just another Postgres schema.