cityofnewyork-us/dycd-program-sites-ebkm-iyma
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 dycd_program_sites table in this repository, by referencing it like:

"cityofnewyork-us/dycd-program-sites-ebkm-iyma:latest"."dycd_program_sites"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "geocoded_column",
    "bbl", -- The BBL (Borough, Block, and Lot) is a unique identifier for each tax lot in the City
    "nta", -- Neighborhood Tabulation Area in which the program site is located.
    "state", -- The state in which the program site is located.
    "zipcode", -- The zipcode for the street address of the program site.
    "latitude", -- Latitude of the program site.
    "longitude", -- Longitude of the program site.
    "x_coordinate", -- The NYC X-coordinate of the program site.
    "city_council_district", -- City Council district in which the program site is located.
    "y_coordinate", -- The NYC Y-coordinate of the program site.
    "nda", -- Neighborhood Development Area (if applicable) in which the program site is located. NDAs are used by DYCD to identify areas for Community Anti-Poverty Programs.
    ":@computed_region_f5dn_yrer",
    ":@computed_region_yeji_bk3q",
    ":@computed_region_92fq_4b7q",
    ":@computed_region_sbqj_enih",
    ":@computed_region_efsh_h5xi",
    "bin", -- The BIN (Building Identification Number) is a unique identifier for each building in the City
    "date", -- Fiscal Year during which the program site was operating.
    "program_area", -- DYCD unit monitoring this program site
    "program_type", -- The program model (within the broader Program Area) under which this program site operates
    "service_category", -- Type of services provided at this site for this contract, used for identification on DiscoverDYCD. Each Program Type has one or more associated Service Categories.
    "provider", -- The community-based organization associated with this contract and workscope.
    "program_site_name", -- The name under which this program site is identified in DYCD systems
    "borough", -- The borough for the street address of the program site.
    "census_tract_2010", -- Census tract (2010) in which the program site is located.
    "totalslots", -- The number of funded slots for this program site.
    "ntaname", -- The neighborhood name associated with the NTA. 
    "street_address", -- The street address of the program site.
    "totalparticipants", -- The number of enrolled participants for this program site. 
    "city", -- The city listed in the address of the program site.
    "contract", -- The DYCD contract number associated with this program site. 
    "portfolioid", -- The DYCD identifier used to differentiate between program sites under a contract where each program site has individual deliverables. 
    "age_range",
    "community_name", -- Community District in which the program site is located.
    "communitydistrict" -- Community District in which the program site is located.
FROM
    "cityofnewyork-us/dycd-program-sites-ebkm-iyma:latest"."dycd_program_sites"
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/dycd-program-sites-ebkm-iyma 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/dycd-program-sites-ebkm-iyma: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)"
 

Read the installation docs.

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/dycd-program-sites-ebkm-iyma" \
  --handler-options '{
    "domain": "data.cityofnewyork.us",
    "tables": {
        "dycd_program_sites": "ebkm-iyma"
    }
}'

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/dycd-program-sites-ebkm-iyma is just another Postgres schema.