cambridgema-gov/american-community-survey-2013-17-estimates-by-mayq-xm5d
Icon for Socrata external plugin

Query the Data Delivery Network

Query the DDN

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

"cambridgema-gov/american-community-survey-2013-17-estimates-by-mayq-xm5d:latest"."american_community_survey_2013_17_estimates_by"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    ":@computed_region_guic_hr4a",
    "geocoded_column",
    "other_vacant_units_1", -- Proportion of units in the neighborhood that are unoccupied but are unavailable to new permanent occupants through the rental or sale market.
    "housing_units", -- A housing unit consists of separate living quarters where the occupants live apart from any other people in the building and that has direct access from the outside of the building or through a common hall. A housing unit may consist of a house, an apartment, a group of rooms, or a single room that is occupied (or if vacant, is intended for occupancy) as separate living quarters.
    "renter_occupied_units", -- A housing unit consists of separate living quarters where the occupants live apart from any other people in the building and that has direct access from the outside of the building or through a common hall. A housing unit may consist of a house, an apartment, a group of rooms, or a single room that is occupied (or if vacant, is intended for occupancy) as separate living quarters.
    "market_vacant_units_1", -- Proportion of units in the neighborhood that are unoccupied and available to new permanent occupants through the rental or sale market.
    "renter_occupied_as_of_occupied", -- Proportion of all occupied units in the neighborhood that are renter-occupied.
    "centerpoint_y",
    "land_area_in_acres",
    "area",
    ":@computed_region_e4yd_rwk4",
    ":@computed_region_swkg_bavi",
    "vacant_units_1", -- Proportion of vacant housing units in neighborhood.
    "centerpoint_x",
    "market_vacant_units", -- Unoccupied units in neighborhood that are available to new permanent occupants through the rental or sale market.
    "total_occupied_units", -- A housing unit consists of separate living quarters where the occupants live apart from any other people in the building and that has direct access from the outside of the building or through a common hall. A housing unit may consist of a house, an apartment, a group of rooms, or a single room that is occupied (or if vacant, is intended for occupancy) as separate living quarters.
    "owner_occupied_units", -- A housing unit consists of separate living quarters where the occupants live apart from any other people in the building and that has direct access from the outside of the building or through a common hall. A housing unit may consist of a house, an apartment, a group of rooms, or a single room that is occupied (or if vacant, is intended for occupancy) as separate living quarters.
    "housing_units_per_acre", -- A housing unit consists of separate living quarters where the occupants live apart from any other people in the building and that has direct access from the outside of the building or through a common hall. A housing unit may consist of a house, an apartment, a group of rooms, or a single room that is occupied (or if vacant, is intended for occupancy) as separate living quarters.
    "neighborhood", -- Cambridge neighborhood
    "vacant_units", -- The Census Bureau treats all unoccupied units as vacant. Vacant units include those set aside for part time occupancy, such as vacation and other second homes, temporary worker housing, homes for rent or for sale, homes rented or sold and awaiting occupancy, and vacant units that are not on the market.
    "other_vacant_units", -- Units categorized as “other vacant” include those unoccupied units categorized by the Census Bureau as “Rented, Not Occupied”, “Sold, Not Occupied”, “For Seasonal, Recreational, or Occasional Use”, "For Migrant Workers” and “Other Vacant”. These units are unavailable to new permanent occupants through the for-rent or for-sale housing markets and are excluded from the market vacancy rate.
    ":@computed_region_rffn_qbt6",
    "owner_occupied_as_of_occupied", -- Proportion of all occupied units in the neighborhood that are owner-occupied.
    "housing_units_as_of_city", -- Neighborhood housing units as proportion of city total.
    ":@computed_region_v7jj_366k"
FROM
    "cambridgema-gov/american-community-survey-2013-17-estimates-by-mayq-xm5d:latest"."american_community_survey_2013_17_estimates_by"
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 cambridgema-gov/american-community-survey-2013-17-estimates-by-mayq-xm5d with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.cambridgema.gov. When you querycambridgema-gov/american-community-survey-2013-17-estimates-by-mayq-xm5d: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

Install Splitgraph Locally
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.cambridgema.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 \
  "cambridgema-gov/american-community-survey-2013-17-estimates-by-mayq-xm5d" \
  --handler-options '{
    "domain": "data.cambridgema.gov",
    "tables": {
        "american_community_survey_2013_17_estimates_by": "mayq-xm5d"
    }
}'

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, cambridgema-gov/american-community-survey-2013-17-estimates-by-mayq-xm5d is just another Postgres schema.

Related Documentation: