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 covid19_vaccinations_in_the_united_statescounty table in this repository, by referencing it like:
"cdc-gov/covid19-vaccinations-in-the-united-statescounty-8xkx-amqh:latest"."covid19_vaccinations_in_the_united_statescounty"or in a full query, like:
SELECT
":id", -- Socrata column ID
"bivalent_booster_65plus_pop_pct", -- Percent of people ages 65+ with an updated (bivalent) booster dose
"bivalent_booster_18plus_pop_pct", -- Percent of people ages 18+ with an updated (bivalent) booster dose
"bivalent_booster_12plus_pop_pct", -- Percent of people ages 12+ with an updated (bivalent) booster dose
"bivalent_booster_5plus", -- Total number of people ages 5+ with an updated (bivalent) booster dose
"census2019_65pluspop", -- 2019 Census Population for ≥65 years of age
"census2019_12pluspop", -- 2019 Census Population for ≥12 years of age
"census2019_5pluspop", -- 2019 Census Population for ≥5 years of age
"census2019", -- 2019 Census Population
"booster_doses_vax_pct_svi", -- Percent of Pop Fully Vaccinated with Booster Dose/SVI
"series_complete_5pluspop_pct_ur_equity", -- Percent of 5+ Pop Fully Vaccinated/MetroNon-Metro
"series_complete_pop_pct_svi", -- Percent of Population Fully Vaccinated/SVI
"second_booster_65plus_vax_pct", -- Percentage of people ages 65+ with a first booster dose who received a second booster dose.
"second_booster_65plus", -- Total number of people ages 65+ who have received a second booster dose.
"second_booster_50plus_vax_pct", -- Percentage of people ages 50+ with a first booster dose who received a second booster dose.
"second_booster_50plus", -- Total number of people ages 50+ who have received a second booster dose.
"booster_doses_65plus_vax_pct", -- Percent of people ages 65+ who completed a primary series and have received a booster (or additional) dose.
"booster_doses_50plus_vax_pct", -- Percent of people ages 50+ who completed a primary series and have received a booster (or additional) dose.
"booster_doses_50plus", -- Total number of people ages 50+ who completed a primary series and have received a booster (or additional) dose.
"booster_doses_18plus_vax_pct", -- Percent of people ages 18+ who completed a primary series and have received a booster (or additional) dose.
"booster_doses_18plus", -- Total number of people ages 18+ who completed a primary series and have received a booster (or additional) dose.
"booster_doses_12plus_vax_pct", -- Percent of people ages 12+ who completed a primary series and have received a booster (or additional) dose.
"booster_doses_5plus_vax_pct", -- Percent of people ages 5+ who completed a primary series and have received a booster (or additional) dose.
"booster_doses_5plus", -- Total number of people ages 5+ who completed a primary series and have received a booster (or additional) dose.
"booster_doses", -- Total number of people who completed a primary series and have received a booster (or additional) dose.
"series_complete_65pluspop_pct", -- Percent of people ages 65+ who have completed a primary series (have second dose of a two-dose vaccine or one dose of a single-dose vaccine) based on the jurisdiction where vaccine recipient lives
"series_complete_18pluspop_pct", -- Percent of people ages 18+ who have completed a primary series (have second dose of a two-dose vaccine or one dose of a single-dose vaccine) based on the jurisdiction and county where vaccine recipient lives
"series_complete_18plus", -- Total number of people ages 18+ who have completed a primary series (have second dose of a two-dose vaccine or one dose of a single-dose vaccine) based on the jurisdiction and county where vaccine recipient lives
"series_complete_12plus", -- Total number of people ages 12+ who have completed a primary series (have second dose of a two-dose vaccine or one dose of a single-dose vaccine) based on the jurisdiction and county where vaccine recipient lives
"series_complete_5to17", -- Total number of people ages 5-17 years who have completed a primary series (have second dose of a two-dose vaccine or one dose of a single-dose vaccine) based on the jurisdiction where recipient lives
"series_complete_5plus", -- Total number of people ages 5+ who have completed a primary series (have second dose of a two-dose vaccine or one dose of a single-dose vaccine) based on the jurisdiction where recipient lives
"series_complete_yes", -- Total number of people who have completed a primary series (have second dose of a two-dose vaccine or one dose of a single-dose vaccine) based on the jurisdiction and county where vaccine recipient lives
"administered_dose1_recip_65plus", -- People 65+ with at least one Dose by State of Residence
"administered_dose1_recip_18pluspop_pct", -- Percent of 18+ Pop with at least one Dose by State of Residence
"administered_dose1_recip_18plus", -- People 18+ with at least one Dose by State of Residence
"administered_dose1_recip_5plus", -- Total number of people 5+ with at least one dose based on the jurisdiction where recipient lives
"completeness_pct", -- Represents the proportion of people with a completed primary series whose Federal Information Processing Standards (FIPS) code is reported and matches a valid county FIPS code in the jurisdiction.
"recip_state", -- Recipient State
"recip_county", -- County of residence
"mmwr_week", -- MMWR Week
"fips", -- Federal Information Processing Standard State Code
"date", -- Date data are reported on CDC COVID Data Tracker
"census2019_18pluspop", -- 2019 Census Population for ≥18 years of age
"series_complete_pop_pct_ur_equity", -- Percent of Population Fully Vaccinated/MetroNon-Metro
"series_complete_18pluspop_pct_svi", -- Percent of 18+ Pop Fully Vaccinated/SVI
"series_complete_5to17pop_pct_svi", -- Percent of 5-17 Pop Fully Vaccinated/SVI
"booster_doses_65plus", -- Total number of people ages 65+ who completed a primary series and have received a booster (or additional) dose.
"booster_doses_vax_pct", -- Percent of people who completed a primary series and have received a booster (or additional) dose.
"series_complete_5to17pop_pct", -- Percent of people ages 5-17 years who have completed a primary series (have second dose of a two-dose vaccine or one dose of a single-dose vaccine) based on the jurisdiction where recipient lives
"series_complete_5pluspop_pct", -- Percent of people ages 5+ who have completed a primary series (have second dose of a two-dose vaccine or one dose of a single-dose vaccine) based on the jurisdiction where recipient lives
"administered_dose1_recip_5pluspop_pct", -- Percent of 5+ population with at least one dose based on the jurisdiction where recipient lives
"administered_dose1_pop_pct", -- Percent of Total Pop with at least one Dose by State of Residence
"booster_doses_12plus", -- Total number of people ages 12+ who completed a primary series and have received a booster (or additional) dose.
"series_complete_5pluspop_pct_svi", -- Percent of 5+ Pop Fully Vaccinated/SVI
"bivalent_booster_12plus", -- Total number of people ages 12+ with an updated (bivalent) booster dose
"census2019_5to17pop", -- 2019 Census Population for 5-17 years of age
"booster_doses_12plusvax_pct_svi", -- Percent of 12+ Pop Fully Vaccinated with Booster Dose/SVI
"series_complete_65pluspop_pct_svi", -- Percent of 65+ Pop Fully Vaccinated/SVI
"series_complete_12pluspop_pct_svi", -- Percent of 12+ Pop Fully Vaccinated/SVI
"administered_dose1_recip_12plus", -- People 12+ with at least one Dose by State of Residence
"administered_dose1_recip", -- People with at least one Dose by State of Residence
"booster_doses_18plusvax_pct_ur_equity", -- Percent of 18+ Pop Fully Vaccinated with Booster Dose/MetroNon-Metro
"series_complete_12pluspop_pct", -- Percent of people ages 12+ who have completed a primary series (have second dose of a two-dose vaccine or one dose of a single-dose vaccine) based on the jurisdiction and county where vaccine recipient lives
"administered_dose1_recip_65pluspop_pct", -- Percent of 65+ Pop with at least one Dose by State of Residence
"booster_doses_65plusvax_pct_ur_equity", -- Percent of 65+ Pop Fully Vaccinated with Booster Dose/MetroNon-Metro
"booster_doses_18plusvax_pct_svi", -- Percent of 18+ Pop Fully Vaccinated with Booster Dose/SVI
"series_complete_65plus", -- Total number of people ages 65+ who have completed a primary series (have second dose of a two-dose vaccine or one dose of a single-dose vaccine) based on the jurisdiction where vaccine recipient lives
"booster_doses_12plusvax_pct_ur_equity", -- Percent of 12+ Pop Fully Vaccinated with Booster Dose/MetroNon-Metro
"booster_doses_vax_pct_ur_equity", -- Percent of Population Fully Vaccinated with Booster Dose/MetroNon-Metro
"svi_ctgy", -- SVI
"series_complete_pop_pct", -- Percent of people who have completed a primary series (have second dose of a two-dose vaccine or one dose of a single-dose vaccine) based on the jurisdiction and county where vaccine recipient lives
"series_complete_5to17pop_pct_ur_equity", -- Percent of 5-17 Pop Fully Vaccinated/MetroNon-Metro
"bivalent_booster_65plus", -- Total number of people ages 65+ with an updated (bivalent) booster dose
"series_complete_65pluspop_pct_ur_equity", -- Percent of 65+ Pop Fully Vaccinated/MetroNon-Metro
"administered_dose1_recip_12pluspop_pct", -- Percent of 12+ Pop with at least one Dose by State of Residence
"bivalent_booster_5plus_pop_pct", -- Percent of people ages 5+ with an updated (bivalent) booster dose
"booster_doses_65plusvax_pct_svi", -- Percent of 65+ Pop Fully Vaccinated with Booster Dose/SVI
"bivalent_booster_18plus", -- Total number of people ages 18+ with an updated (bivalent) booster dose
"series_complete_18pluspop_pct_ur_equity", -- Percent of 18+ Pop Fully Vaccinated/MetroNon-Metro
"series_complete_12pluspop_pct_ur_equity", -- Percent of 12+ Pop Fully Vaccinated/MetroNon-Metro
"metro_status" -- Metro/Non-metro
FROM
"cdc-gov/covid19-vaccinations-in-the-united-statescounty-8xkx-amqh:latest"."covid19_vaccinations_in_the_united_statescounty"
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 cdc-gov/covid19-vaccinations-in-the-united-statescounty-8xkx-amqh with SQL in under 60 seconds.
This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.cdc.gov. When you querycdc-gov/covid19-vaccinations-in-the-united-statescounty-8xkx-amqh: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.cdc.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 \
"cdc-gov/covid19-vaccinations-in-the-united-statescounty-8xkx-amqh" \
--handler-options '{
"domain": "data.cdc.gov",
"tables": {
"covid19_vaccinations_in_the_united_statescounty": "8xkx-amqh"
}
}'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, cdc-gov/covid19-vaccinations-in-the-united-statescounty-8xkx-amqh is just another Postgres schema.