mydata-iowa-gov/iowa-unemployment-insurance-benefit-payments-and-aeyn-twxp
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 procotol. 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 iowa_unemployment_insurance_benefit_payments_and table in this repository, by referencing it like:

"mydata-iowa-gov/iowa-unemployment-insurance-benefit-payments-and-aeyn-twxp:latest"."iowa_unemployment_insurance_benefit_payments_and"

or in a full query, like:

SELECT 
    ":id", -- Socrata column ID
    "gnis_feature_id", -- ID for county provided by U.S. Geographic Names Information System (GNIS): U.S. Geological Survey, Reston, VA.  County based on recipients place of residence.
    "county_name", -- County recipients reside
    "month_ending", -- Stored as month ending date.  Displayed as month.
    "first_payments", -- The number of claimants residing in the county receiving their the first payment in a benefit year for a week of unemployment claimed under the state UI program.
    "recipients", -- The number of claimants residing in the county receiving at least one regular UI benefit payment during the month.  The recipients column cannot be summed over multiple time periods. Summing months into a year will cause a duplicate count since some recipients will be be counted in several months
    "weeks_compensated", -- The number of weeks claimed by recipients residing in county for which UI benefits are paid. Weeks compensated for partial unemployment are included.
    "primary_lat_dec", -- Primary latitude in decimal degrees for the county as provided by U.S. Geological Survey, 19810501, U.S. Geographic Names Information System (GNIS): U.S. Geological Survey, Reston, VA.
    "primary_county_coordinates", -- Primary coordinate for the county in decimal degrees.
    "sort_code", -- Sorts data by descending date and ascending county name
    "primary_long_dec", -- Primary longitude in decimal degrees for the county as provided by U.S. Geological Survey, 19810501, U.S. Geographic Names Information System (GNIS): U.S. Geological Survey, Reston, VA.
    "county_fip", -- A five-digit Federal Information Processing Series code to ensure uniform identification of counties.  Code based on recipients place of residence.
    "final_payments", -- Number of claimants residing in the county drawing the final payment of their original entitlement of UI (exhaustees).
    "benefits_paid", -- Unemployment benefits paid to individuals residing in the county.
    ":@computed_region_3r5t_5243",
    ":@computed_region_wnea_7qqw",
    ":@computed_region_i9mz_6gmt",
    ":@computed_region_e7ym_nrbf"
FROM
    "mydata-iowa-gov/iowa-unemployment-insurance-benefit-payments-and-aeyn-twxp:latest"."iowa_unemployment_insurance_benefit_payments_and"
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 mydata-iowa-gov/iowa-unemployment-insurance-benefit-payments-and-aeyn-twxp with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at mydata.iowa.gov. When you querymydata-iowa-gov/iowa-unemployment-insurance-benefit-payments-and-aeyn-twxp: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 mydata.iowa.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 \
  "mydata-iowa-gov/iowa-unemployment-insurance-benefit-payments-and-aeyn-twxp" \
  --handler-options '{
    "domain": "mydata.iowa.gov",
    "tables": {
        "iowa_unemployment_insurance_benefit_payments_and": "aeyn-twxp"
    }
}'

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, mydata-iowa-gov/iowa-unemployment-insurance-benefit-payments-and-aeyn-twxp is just another Postgres schema.

Related Documentation: