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

"calgary-ca/civic-census-by-community-and-dwelling-structure-set9-futw:latest"."civic_census_by_community_and_dwelling_structure"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "under_const_dwelling_cnt", -- Count of dwelling units under construction. A dwelling unit is considered under construction as as soon as the foundation is poured, and until it is ready for occupancy.
    "dwelling_type_description", -- Description of the dwelling type.
    "ocpd_dwelling_cnt", -- Count of dwellings with confirmed residents
    "other_purpose_cnt", -- Count of structures or units originally built as a dwelling and which could be used as a dwelling again, but which is presently used for a non-residential purpose (e.g. show home)
    "inactive_cnt", -- Count of inactive dwelling units. A dwelling unit that is part of a multi-dwelling unit structure and is being used as part of another dwelling unit in the same physical structure (e.g. both halves of a duplex used by one family); or a vacant pad in a mobile home park; or a converted structure unit like a basement suite, which is not occupied as a dwelling unit, has not been removed, is not being renovated but is not available for occupancy; or a dwelling unit that has been boarded-up, scheduled for demolition, fenced or taped off, condemned, or otherwise uninhabitable.
    "renovation_dwelling_cnt", -- Count of dwelling units vacant because of renovations
    "ocpd_ownership_cnt", -- Count of dwellings occupied by home owners
    "vacant_dwelling_cnt", -- Count of dwelling units uninhabited at the time of the census, but suitable and available for occupancy
    "resident_cnt", -- Count of residents. A person who maintains residence in the city is considered a resident. Residents include newly arrived persons, persons absent for educational purposes, persons temporarily at remote work sites, etc.
    "dwelling_cnt", -- Count of dwellings
    "dwelling_type", -- Refers to the physical building or structure in which the dwelling unit is located. It is not a reference to the use or ownership of the dwelling.
    "ward", -- Municipal electoral ward
    "community", -- Name of the community
    "code", -- Abbreviation used to represent communities
    "census_year", -- Year the data was collected
    "dwelling_type_code" -- Numerical code of the dwelling type.
FROM
    "calgary-ca/civic-census-by-community-and-dwelling-structure-set9-futw:latest"."civic_census_by_community_and_dwelling_structure"
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 calgary-ca/civic-census-by-community-and-dwelling-structure-set9-futw with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.calgary.ca. When you querycalgary-ca/civic-census-by-community-and-dwelling-structure-set9-futw: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.calgary.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 \
  "calgary-ca/civic-census-by-community-and-dwelling-structure-set9-futw" \
  --handler-options '{
    "domain": "data.calgary.ca",
    "tables": {
        "civic_census_by_community_and_dwelling_structure": "set9-futw"
    }
}'

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, calgary-ca/civic-census-by-community-and-dwelling-structure-set9-futw is just another Postgres schema.