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 nursing_home_weekly_bed_census_beginning_2009 table in this repository, by referencing it like:
"health-data-ny-gov/nursing-home-weekly-bed-census-beginning-2009-uhyy-xp9s:latest"."nursing_home_weekly_bed_census_beginning_2009"or in a full query, like:
SELECT
":id", -- Socrata column ID
"longitude", -- Facility Longitude
"latitude", -- Facility Latitude
"adhc_slots", -- The number of Adult Day Health Care Slots the facility is approved to operate.
"traumatic_brain_injury_beds_av", -- Available Traumatic Brain Injury (TBI) Beds reported by facility. This figure should include any licensed TBI beds that are not operational.
"ventilator_beds", -- The number of Ventilator Beds the facility is approved to operate
"census_date", -- Census date
"zip", -- Facility zip code
"street_address", -- Facility street address
"special_circumstances", -- Any notes added
"ndg_beds", -- Total Neurodegenerative Disease Beds reported by facility. This figure should include any licensed neurodegenerative disease beds that are approved to operate
"traumatic_brain_injury_beds", -- The number of Traumatic Brain Injury Beds the facility is approved to operate.
"scatter_ventilator_beds", -- The number of Scatter Ventilator Beds the facility is capable of operating.
"behavioral_intervention_beds", -- The number of Behavioral Intervention Beds the facility is approved to operate.
"facility_status", -- Status of facility: OPEN or CLOSED
"dialysis_station_dens", -- The number of Dialysis Station Dens the facility is approved to operate.
"dialysis_station_beds", -- The number of Dialysis Station Beds the facility is approved to operate.
"adhc_slots_av", -- The number of Adult Day Health Care Slots the facility reported by facility. This figure should include any licensed adult day health care slots that are approved to operate
"scatter_ventilator_beds_av", -- Available Scatter Ventilator Beds reported by facility
"ventilator_beds_av", -- Available Ventilator Beds reported by facility. This figure should include any licensed ventilator beds that are not operational
"behavioral_intervention_beds_av", -- Available Behavioral Intervention Beds reported by facility. This figure should include any licensed behavioral intervention beds that are not operational.
"pediatric_beds_av", -- Available Pediatric Beds reported by facility. This figure should include any licensed pediatric beds that are not operational.
"pediatric_beds", -- The number of Pediatric Beds the facility is approved to operate.
"nursing_home_beds_av", -- Available Residential Beds reported by facility. This figure should include any licensed beds that are not operational.
"nursing_home_beds", -- The number of Residential Beds the facility is approved to operate
"phone_number", -- Facility phone number
"area_office", -- Facility area office
"state", -- Facility state
"city", -- Facility city
"certification_number", -- Operating Certificate number
"facility_name", -- Name of nursing home
"county", -- Facility county
"ndg_beds_av", -- Available Neurodegenerative Disease Beds reported by facility. This figure should include any licensed Neurodegenerative Disease Beds that are not operational
"facility_id", -- Health Facility Information System Facility ID Number
"pediatric_ventilator_beds", -- Available Pediatric Ventilator Beds reported by facility. This figure should include any licensed pediatric ventilator beds that are not operational.
"website" -- Facility website address
FROM
"health-data-ny-gov/nursing-home-weekly-bed-census-beginning-2009-uhyy-xp9s:latest"."nursing_home_weekly_bed_census_beginning_2009"
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 health-data-ny-gov/nursing-home-weekly-bed-census-beginning-2009-uhyy-xp9s with SQL in under 60 seconds.
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, 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 (like this repository), where the author has pushed Splitgraph Images to the repository, you can "clone" and/or "checkout" the data using sgr cloneand sgr checkout.
Cloning Data
Because health-data-ny-gov/nursing-home-weekly-bed-census-beginning-2009-uhyy-xp9s:latest is a Splitgraph Image, you can clone the data from Spltgraph Cloud to your local engine, where you can query it like any other Postgres database, using any of your existing tools.
First, install Splitgraph if you haven't already.
Clone the metadata with sgr clone
This will be quick, and does not download the actual data.
sgr clone health-data-ny-gov/nursing-home-weekly-bed-census-beginning-2009-uhyy-xp9sCheckout the data
Once you've cloned the data, you need to "checkout" the tag that you want. For example, to checkout the latest tag:
sgr checkout health-data-ny-gov/nursing-home-weekly-bed-census-beginning-2009-uhyy-xp9s:latestThis will download all the objects for the latest tag of health-data-ny-gov/nursing-home-weekly-bed-census-beginning-2009-uhyy-xp9s and load them into the Splitgraph Engine. Depending on your connection speed and the size of the data, you will need to wait for the checkout to complete. Once it's complete, you will be able to query the data like you would any other Postgres database.
Alternatively, use "layered checkout" to avoid downloading all the data
The data in health-data-ny-gov/nursing-home-weekly-bed-census-beginning-2009-uhyy-xp9s:latest is 0 bytes. If this is too big to download all at once, or perhaps you only need to query a subset of it, you can use a layered checkout.:
sgr checkout --layered health-data-ny-gov/nursing-home-weekly-bed-census-beginning-2009-uhyy-xp9s:latestThis will not download all the data, but it will create a schema comprised of foreign tables, that you can query as you would any other data. Splitgraph will lazily download the required objects as you query the data. In some cases, this might be faster or more efficient than a regular checkout.
Read the layered querying documentation to learn about when and why you might want to use layered queries.
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, health-data-ny-gov/nursing-home-weekly-bed-census-beginning-2009-uhyy-xp9s is just another Postgres schema.