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

"cityofnewyork-us/civil-service-list-active-vx8i-nprf:latest"."civil_service_list_active"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "list_no", -- An eligible candidate’s placement on a given list as of the business day that the data set is populated.   
    "list_title_desc", -- A descriptive name that identifies a civil service title.  
    "list_div_code", -- The promotional division codes/descriptions within the New York City Transit Authority only. 
    "first_name", -- A candidate’s first name as it appears on their application. 
    "list_agency_desc", -- The name of an appointing Agency. 
    "published_date", -- The date on which an eligible list is made available for review by the general public and appointing agencies.   
    "extension_date", -- The date on which a list will be extended beyond its original expiration date.   
    "veteran_credit", -- An additional credit given to a Veteran (5 points) or disabled veteran (10 points) when s/he accepts a permanent position from an eligible list.  
    "mi", -- A candidate’s middle initial (MI) as it appears on their application. 
    "anniversary_date", -- The date on which an eligible list is scheduled to expire.       
    "sibling_lgy_credit", -- A “Sibling Legacy Credit” is additional credit given on an exam (10 points) to a candidate who lost a sibling (FDNY, NYPD, or a First Responder, during or as a result of 911). 
    "last_name", -- A candidate’s last name as it appears on their application. 
    "list_title_code", -- A five (5) digit number that corresponds to and represents a civil service title. 
    "list_agency_code", -- A three (3) digit number used to identify an agency (For Promotion List Only). 
    "established_date", -- The date on which an eligible list is made available for certification to agencies to consider an eligible candidate for appointment. 
    "parent_lgy_credit", -- A “Parent Legacy credit” is an additional credit given on an exam (10 points) to a candidate who lost a parent (FDNY, NYPD, or a First Responder, during or as a result of 911). 
    "group_no", -- Represents the certification order for a list. (e.g. – eligible candidates on a list with a 01 group number may be considered for appointment before an eligible candidate on primary list with a 00 group number). 
    "residency_credit", -- An additional credit given on an exam to a candidate who maintains a continuous period of residency in New York City as described in the Notice of Examination for a specific title.      
    "adj_fa", -- The Adjusted Final Average (“Adj. FA” or “AFA”) is an eligible candidate’s test score in addition to any additional credits granted. 
    "exam_no" -- A four (4) digit number that identifies a civil service examination.   
FROM
    "cityofnewyork-us/civil-service-list-active-vx8i-nprf:latest"."civil_service_list_active"
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 cityofnewyork-us/civil-service-list-active-vx8i-nprf with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.cityofnewyork.us. When you querycityofnewyork-us/civil-service-list-active-vx8i-nprf: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.cityofnewyork.us, 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 \
  "cityofnewyork-us/civil-service-list-active-vx8i-nprf" \
  --handler-options '{
    "domain": "data.cityofnewyork.us",
    "tables": {
        "civil_service_list_active": "vx8i-nprf"
    }
}'

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, cityofnewyork-us/civil-service-list-active-vx8i-nprf is just another Postgres schema.