usaid-gov/feed-the-future-northern-kenya-interim-survey-in-rax3-7wmz
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 feed_the_future_northern_kenya_interim_survey_in table in this repository, by referencing it like:

"usaid-gov/feed-the-future-northern-kenya-interim-survey-in-rax3-7wmz:latest"."feed_the_future_northern_kenya_interim_survey_in"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "cluster", -- Cluster number
    "exp_class", -- Expenditure classification
    "erslt2",
    "zoi", -- This variable indicates that a record is included in the Feed the Future Zone of Influence. The ZOI includes the counties of Marsabit, Garissa, Isiolo, Wajir, and Turkana.
    "remain_useage", -- Derived durable remaining use age
    "e704", -- What is the age of these ITEM s? IF MORE THAN ONE ITEM, AVERAGE AGE
    "urbrur", -- Location type (urban rural)
    "country", -- These data were collected in the Feed the Future Zone of Influence in Kenya.
    "e706", -- Did you purchase or pay for any of these ITEM s in the last 12 months?
    "e701", -- ITEM
    "e702", -- Does your household own a ITEM ?
    "imp_value", -- Imputation flag for durable value
    "e705", -- If you wanted to sell one of these ITEM s today, how much would you receive? IF MORE THAN ONE, AVERAGE VALUE
    "dailyvalue", -- Derived daily durable expenditure for aggregation
    "survey", -- These data were collected in the 2015 Interim Zone of Influence Survey.
    "pbs_id", -- Administrative variable for identifying households
    "dropflag", -- Drop flag - item consumed by 20 households to be dropped
    "erslt1",
    "e703", -- How many ITEM s do you own?
    "imp_age", -- Imputation flag for durable remaining use age
    "stratum", -- Administrative variable for identifying the strata of sampling designs. Unstratified samples have a constant value of 1.
    "today", -- Survey Date
    "e707" -- How much did you pay for all these ITEM s all together (total) in the last 12 months?
FROM
    "usaid-gov/feed-the-future-northern-kenya-interim-survey-in-rax3-7wmz:latest"."feed_the_future_northern_kenya_interim_survey_in"
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 usaid-gov/feed-the-future-northern-kenya-interim-survey-in-rax3-7wmz with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.usaid.gov. When you queryusaid-gov/feed-the-future-northern-kenya-interim-survey-in-rax3-7wmz: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.usaid.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 \
  "usaid-gov/feed-the-future-northern-kenya-interim-survey-in-rax3-7wmz" \
  --handler-options '{
    "domain": "data.usaid.gov",
    "tables": {
        "feed_the_future_northern_kenya_interim_survey_in": "rax3-7wmz"
    }
}'

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, usaid-gov/feed-the-future-northern-kenya-interim-survey-in-rax3-7wmz is just another Postgres schema.