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

"ny-gov/new-york-state-government-building-energy-use-nfvi-5nt4:latest"."new_york_state_government_building_energy_use"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "year", -- State Fiscal Year [April 1st – March 31st] of reporting period.
    "zip_code", -- United States Postal Service established Zone Improvement Program Codes.
    "agency_name", -- Affected State Entity eligible for Executive Order 88 Reporting.
    "source_kbtu", -- The total kBtu site is converted to Source Energy which takes into account the fuels consumed in the generation, transmission, and distribution of electricity, as well as the energy losses from storage, distribution, and delivery of each unit fuel. 
    "gross_floor_area", -- The gross square footage-the sum of all areas on all floors of a building included within the outside faces of its exterior walls, including all vertical penetration areas for circulation and shaft areas that connect one floor to another.
    "building_facility_name", -- Individually metered building or master metered campus within each state entity.
    "source_eui" -- The Source kBtu divided by the gross square footage generates the Energy Use Intensity-which is the standard performance metric used to measure Executive Order 88 goals.
FROM
    "ny-gov/new-york-state-government-building-energy-use-nfvi-5nt4:latest"."new_york_state_government_building_energy_use"
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 ny-gov/new-york-state-government-building-energy-use-nfvi-5nt4 with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.ny.gov. When you queryny-gov/new-york-state-government-building-energy-use-nfvi-5nt4: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.ny.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 \
  "ny-gov/new-york-state-government-building-energy-use-nfvi-5nt4" \
  --handler-options '{
    "domain": "data.ny.gov",
    "tables": {
        "new_york_state_government_building_energy_use": "nfvi-5nt4"
    }
}'

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, ny-gov/new-york-state-government-building-energy-use-nfvi-5nt4 is just another Postgres schema.