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

"cityofchicago/violence-reduction-victim-demographics-aggregated-gj7a-742p:latest"."violence_reduction_victim_demographics_aggregated"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "gunshot_injury_i", -- Indicator field describing whether or not a victim was injured by gunfire. Shooting data is not available before 2010 so all non-homicide victimizations prior to 2010 will be recorded as “UNKNOWN.”
    "sex", -- The sex of the victims. Victimization demographic data shown here are captured by CPD and limited to information included in the police report, which sometimes is not supported by individual self-identification including for sex/gender. In particular, CPD has historically recorded a victim’s sex rather than gender although has added an additional field for collecting gender as of January 2021.
    "primary_type", -- Text description of the IUCR Code that describes the major crime category for the corresponding victimization it falls into. This column represents only the crime that this specific victim within the incident experienced.
    "time_period_end", -- All victimizations have been aggregated to the quarter level. This time stamp reflects the end of the quarter.
    "time_period_start", -- All victimizations have been aggregated to the quarter level. This time stamp reflects the start of the quarter.
    "number_of_victims", -- The number of victims matching the unique combination of all other columns.
    "race", -- The race of the victims. Victimization demographic data shown here are captured by CPD and limited to information included in the police report, which may not often be supported by individual self-identification including for race and ethnicity.
    "age", -- The age of the victims grouped by decade.
    "time_period", -- The time period aggregated.
    "domestic_i", -- Indicates whether the aggregated number of victimizations were domestic-related as determined by the initial reporting officer or the investigating detective.
    "juvenile_i" -- Whether the victims were juveniles (under age 18). A blank value means Unknown.
FROM
    "cityofchicago/violence-reduction-victim-demographics-aggregated-gj7a-742p:latest"."violence_reduction_victim_demographics_aggregated"
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 cityofchicago/violence-reduction-victim-demographics-aggregated-gj7a-742p with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.cityofchicago.org. When you querycityofchicago/violence-reduction-victim-demographics-aggregated-gj7a-742p: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.cityofchicago.org, 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 \
  "cityofchicago/violence-reduction-victim-demographics-aggregated-gj7a-742p" \
  --handler-options '{
    "domain": "data.cityofchicago.org",
    "tables": {
        "violence_reduction_victim_demographics_aggregated": "gj7a-742p"
    }
}'

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, cityofchicago/violence-reduction-victim-demographics-aggregated-gj7a-742p is just another Postgres schema.