Query the Data Delivery Network
Query the DDNThe 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 ethiopia_pastoralist_areas_resilience_improvement table in this repository, by referencing it like:
"usaid-gov/ethiopia-pastoralist-areas-resilience-improvement-ufe8-zncd:latest"."ethiopia_pastoralist_areas_resilience_improvement"or in a full query, like:
SELECT
":id", -- Socrata column ID
"q2218_1", -- 2218. How did you give your child goat milk? (Pure milk to drink)
"edmax_none", -- DERIVED: Highest education level in hh: none
"asset_poor", -- DERIVED: Asset poor corresponds to USD 1.25 poverty threshold
"q2218_2", -- 2218. How did you give your child goat milk? (With tea)
"q2222_4", -- 2222. How did you give your child camel milk? (As yogurt)
"q2217_1", -- 2217. Where did this milk come from? (Own animals)
"q2203", -- 2203. Child s sex
"q2210", -- 2210. Weight in kilograms
"q2222_1", -- 2222. How did you give your child camel milk? (Pure milk to drink)
"edmax_sec", -- DERIVED: Highest education level in hh: secondary or higher
"q2214_2", -- 2214. How did you give your child cow milk? (With tea)
"q2213_1", -- 2213. Where did this milk come from? (Own animals)
"q2217_3", -- 2217. Where did this milk come from? (Bought)
"fem_only", -- DERIVED: Household with all adult females
"q2223", -- 2223. How much camel milk did your child take in the last week? (cups)
"stratum", -- Survey strata
"child_number", -- Number of child within household
"q2214_4", -- 2214. How did you give your child cow milk? (As yogurt)
"q2220", -- 2220. Do you give child camel milk to drink
"edmax_none_f", -- DERIVED: Highest education level of females in hh: none
"pbs_id", -- Household id
"q2222_3", -- 2222. How did you give your child camel milk? (With food)
"q2217_4", -- 2217. Where did this milk come from? (Other)
"q2221_4", -- 2221. Where did this milk come from? (Other)
"edmax_sec_f", -- DERIVED: Highest education level of females in hh: secondary or higher
"q2218_5", -- 2218. How did you give your child goat milk? (Other)
"asset_ind_c", -- DERIVED: Total consumption assets owned
"q2211", -- 2211. Height in centimeters
"pm16_30", -- DERIVED: Percent males 16-30 years of age
"asset_ind_p_01", -- DERIVED: Total consumption assets owned, 0-100 scale
"edmax_prim_f", -- DERIVED: Highest education level of females in hh: primary
"q2218_3", -- 2218. How did you give your child goat milk? (With food)
"q2222_5", -- 2222. How did you give your child camel milk? (Other)
"q2218_4", -- 2218. How did you give your child goat milk? (As yogurt)
"q2214_3", -- 2214. How did you give your child cow milk? (With food)
"pf16_30", -- DERIVED: Percent females 16-30 years of age
"kcal_req_l", -- DERIVED: Hh calorie req: light
"q2213_2", -- 2213. Where did this milk come from? (Relative s animals)
"income_poor", -- DERIVED: Total Per Capita Daily Expenditures USD 1.25
"q2201", -- 2201. Caregiver s ID from Module 2
"int_group", -- Intervention group
"samplewt", -- DERIVED: sample weights
"q2221_3", -- 2221. Where did this milk come from? (Bought)
"q2213_4", -- 2213. Where did this milk come from? (Other)
"q2221_1", -- 2221. Where did this milk come from? (Own animals)
"q2214_1", -- 2214. How did you give your child cow milk? (Pure milk to drink)
"kebele", -- Kebele
"q2214_5", -- 2214. How did you give your child cow milk? (Other)
"q2216", -- 2216. Do you you give child goat mild to drink?
"q2222_2", -- 2222. How did you give your child camel milk? (With tea)
"q2208", -- 2208. Is child under 60 months?
"hhsize", -- DERIVED: Number of household members
"proj_area", -- DERIVED: Project Area (Zone)
"q2217_2", -- 2217. Where did this milk come from? (Relative s animals)
"q2212", -- 2212. Do you give child cow milk to drink?
"com_hh_merge", -- Code to merge community and hh datasets
"q2213_3", -- 2213. Where did this milk come from? (Bought)
"asset_ind_p", -- DERIVED: Total production assets owned
"pastor_status", -- DERIVED: Pastoralist Status
"q2221_2", -- 2221. Where did this milk come from? (Relative s animals)
"q2215", -- 2215. How much cow milk did your child take in the last week? (cups)
"q2219", -- 2219. How much goat milk did your child take in the last week? (cups)
"pm30p", -- DERIVED: Percent males 30 years of age
"tlu", -- DERIVED: Tropical Livestock Unit
"asset_index", -- DERIVED: Total Asset Ownership Index
"q2209", -- 2209. Does child have edema?
"woreda", -- Woreda
"hhae", -- DERIVED: Number of household adult equivalents
"pm0_16", -- DERIVED: Percent males 0-16 years of age
"pf0_16", -- DERIVED: Percent females 0-16 years of age
"pf30p", -- DERIVED: Percent females 30 years of age
"edmax_prim", -- DERIVED: Highest education level in hh: primary
"asset_ind_c_01", -- DERIVED: Total consumption assets owned, 0-100 scale
"ea" -- Unique enumeration area code
FROM
"usaid-gov/ethiopia-pastoralist-areas-resilience-improvement-ufe8-zncd:latest"."ethiopia_pastoralist_areas_resilience_improvement"
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/ethiopia-pastoralist-areas-resilience-improvement-ufe8-zncd 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/ethiopia-pastoralist-areas-resilience-improvement-ufe8-zncd: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)"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/ethiopia-pastoralist-areas-resilience-improvement-ufe8-zncd" \
--handler-options '{
"domain": "data.usaid.gov",
"tables": {
"ethiopia_pastoralist_areas_resilience_improvement": "ufe8-zncd"
}
}'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/ethiopia-pastoralist-areas-resilience-improvement-ufe8-zncd is just another Postgres schema.