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

"cityofnewyork-us/agency-voter-registration-activity-kkum-y97z:latest"."agency_voter_registration_activity"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "rank_choice_voting_materials_distributed", -- Number of materials related to describing ranked choice voting distributed by the agency.
    "applications_distributed", -- Number of postage paid voter registration forms distributed to agency clients.
    "applications_sent_to_boe", -- Number of completed voter registration forms collected by the agency and transmitted to the Board of Elections.
    "web_clicks", -- The number of times an agency website visitor has clicked the voting.nyc weblink.
    "staff_trained", -- Number of agency front-line staff trained to administer voter registration forms.
    "agency", -- City Charter Section 1057-a describes which agencies are required to engage in and report on voter registration activities: Aging, Business Integrity Commission, Children's Services, City Planning, Civilian Complaint Review Board, Commission on Human Rights, Small Business Services, Citywide Administrative Services, Consumer Affairs, Correction, Cultural Affairs, Environmental Protection, Finance, Fire, Health and Mental Hygiene, Homeless Services, Housing Preservation and Development, Human Resources Administration, Parks and Recreation, Probation, Records and Information Services,   Taxi and Limousine Commission, Transportation, and Youth and Community Development.
    "beginning_of_reporting_period", -- The date on which the reporting period begins.
    "end_of_reporting_period", -- The date on which the reporting period ends.
    "agency_weblink_to_nyc_votes", -- Indicates whether the agency provides a weblink to voting.nyc on its website.
    "people_served" -- The estimated number of individuals served by the agency, at all locations where the application is offered, during the reporting period.
FROM
    "cityofnewyork-us/agency-voter-registration-activity-kkum-y97z:latest"."agency_voter_registration_activity"
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/agency-voter-registration-activity-kkum-y97z 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/agency-voter-registration-activity-kkum-y97z: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/agency-voter-registration-activity-kkum-y97z" \
  --handler-options '{
    "domain": "data.cityofnewyork.us",
    "tables": {
        "agency_voter_registration_activity": "kkum-y97z"
    }
}'

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/agency-voter-registration-activity-kkum-y97z is just another Postgres schema.