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

"pa-gov/individuals-with-a-disability-who-receive-services-dc8a-5ftn:latest"."individuals_with_a_disability_who_receive_services"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "number_of_unique_participants", --  Counts of unique individuals with a self-disclosed disability who participated in workforce programs across the Commonwealth.
    "percent_of_participants_with", -- The percentage of participants with a self-disclosed disability is determined by the number shown divided by the total number of participants served during the referenced program year.  
    "program_year", -- July 1 through June 30, e.g. Program Year 2018 is from July 1, 2018 through June 30, 2019.
    "number_of_participants_with", --  Counts of unique individuals with a self-disclosed disability employed after Completing Services  who participated in workforce programs across the Commonwealth.
    "program", -- the name of the Workforce innovation and Opportunity Act program that provided services. All workforce programs is a total and represents an unique count of individuals who received services across all of the workforce programs listed.  An individual can receive services concurrently from multiple programs.  Therefore, the sum of the participants by individual workforce program will be greater than the number of participants in all workforce programs.
    "percent_of_participants_with_1" -- The percent of participants with a self-disclosed disability who were employed after completing program services is determined by the number shown divided by the total number of participants who had completed program services. 
FROM
    "pa-gov/individuals-with-a-disability-who-receive-services-dc8a-5ftn:latest"."individuals_with_a_disability_who_receive_services"
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 pa-gov/individuals-with-a-disability-who-receive-services-dc8a-5ftn with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.pa.gov. When you querypa-gov/individuals-with-a-disability-who-receive-services-dc8a-5ftn: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.pa.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 \
  "pa-gov/individuals-with-a-disability-who-receive-services-dc8a-5ftn" \
  --handler-options '{
    "domain": "data.pa.gov",
    "tables": {
        "individuals_with_a_disability_who_receive_services": "dc8a-5ftn"
    }
}'

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, pa-gov/individuals-with-a-disability-who-receive-services-dc8a-5ftn is just another Postgres schema.