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

"colorado-gov/business-entities-in-colorado-4ykn-tg5h:latest"."business_entities_in_colorado"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "entityid", -- The state assigned identification number (unique) for the business entity.
    "entityname", -- The name of the business entity as selected by the business owner.
    "principaladdress1", -- Principal address for the business entity.
    "principaladdress2", -- Principal address for the business entity.
    "principalcity", -- Principal city for the business entity.
    "principalstate", -- Principal state for the business entity.
    "principalzipcode", -- Principal zip code for the business entity.
    "principalcountry", -- Principal country for the business entity.
    "mailingaddress1", -- Mailing address for the business entity.
    "mailingaddress2", -- Mailing address for the business entity.
    "mailingcity", -- Mailing city for the business entity.
    "mailingstate", -- Mailing state for the business entity.
    "mailingzipcode", -- Mailing zip code for the business entity.
    "mailingcountry", -- Mailing country for the business entity.
    "entitystatus", -- Entity status for the business entity.
    "jurisdictonofformation", -- Jurisdiction of formation
    "entitytype", -- Entity type abbreviation used by the Secretary of State.
    "agentfirstname", -- First name of agent. A registered agent for a business needs to have a Colorado address and serves as the contact for the entity. In the event of litigation, the service of process goes to the registered agent.
    "agentmiddlename", -- Middle name of agent. A registered agent for a business needs to have a Colorado address and serves as the contact for the entity. In the event of litigation, the service of process goes to the registered agent.
    "agentlastname", -- Last name of agent. A registered agent for a business needs to have a Colorado address and serves as the contact for the entity. In the event of litigation, the service of process goes to the registered agent.
    "agentsuffix", -- Agent Suffix
    "agentorganizationname", -- Agent Organization Name
    "agentprincipaladdress1", -- Agent principal address1
    "agentprincipaladdress2", -- Agent principal address2
    "agentprincipalcity", -- Agent principal city
    "agentprincipalstate", -- Agent principal state
    "agentprincipalzipcode", -- Agent principal zip code
    "agentprincipalcountry", -- Agent principal country
    "agentmailingaddress1", -- Agent mailing address1
    "agentmailingaddress2", -- Agent mailing address2
    "agentmailingcity", -- Agent mailing city
    "agentmailingstate", -- Agent mailing state
    "agentmailingzipcode", -- Agent mailing zip code
    "agentmailingcountry", -- Agent mailing country
    "entityformdate" -- Entity form date
FROM
    "colorado-gov/business-entities-in-colorado-4ykn-tg5h:latest"."business_entities_in_colorado"
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 colorado-gov/business-entities-in-colorado-4ykn-tg5h with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.colorado.gov. When you querycolorado-gov/business-entities-in-colorado-4ykn-tg5h: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.colorado.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 \
  "colorado-gov/business-entities-in-colorado-4ykn-tg5h" \
  --handler-options '{
    "domain": "data.colorado.gov",
    "tables": {
        "business_entities_in_colorado": "4ykn-tg5h"
    }
}'

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, colorado-gov/business-entities-in-colorado-4ykn-tg5h is just another Postgres schema.