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 adult_care_facility_annual_survey_20092012 table in this repository, by referencing it like:
"health-data-ny-gov/adult-care-facility-annual-survey-20092012-u847-drrz:latest"."adult_care_facility_annual_survey_20092012"or in a full query, like:
SELECT
":id", -- Socrata column ID
"cert", -- The Operating Certificate Number of the facility.
"reporting_organization", -- The facility name.
"admissions_total", -- Number of residents admitted to the adult care facility throughout the reporting year.
"snalr_capacity_total", -- Refers to the maximum number of Special Needs Assisted Living Residence (SNALR) beds allowed.
"alr_current_census_total", -- The total number of residents listed on the Daily Census Report at 11:59 PM on December 31 who reside in the Assisted Living Residence (ALR).
"snalr_current_census_total", -- The total number of residents listed on the Daily Census Report at 11:59 PM on December 31 who reside in the Special Needs Assisted Living Residence (SNALR).
"ages_18_55_census_total", -- The total number of residents aged 18-55 on the Daily Census Report at 11:59 PM on December 31.
"reporting_year", -- The year being reported on.
"ages_56_65_census_total", -- The total number of residents aged 56-65 on the Daily Census Report at 11:59 PM on December 31.
"ealr_current_census_total", -- The total number of residents listed on the Daily Census Report at 11:59 PM on December 31 who reside in the Enhanced Assisted Living Residence (EALR).
"female_census_total", -- The total number of female residents listed on the Daily Census Report at 11:59 PM on December 31.
"ealr_capacity_total", -- Refers to the maximum number of Enhanced Assisted Living Residence (EALR) beds allowed.
"discharges_total", -- For the purposes of this survey, discharge refers to the permanent release of the resident from an adult care facility following the death of the resident or issuance of a termination notice to the resident (thereby dissolving the residency agreement) and subsequent relocation to another adult care facility, a psychiatric hospital (long term residency), OMH-funded housing, Non-OMH-funded housing, a private residence, a correctional facility, or a nursing home. It does not include temporary transfer to a hospital, psychiatric center, or rehabilitation facility.
"ages_66_80_census_total", -- The total number of residents aged 66-80 on the Daily Census Report at 11:59 PM on December 31.
"total_alp_capacity", -- Refers to the maximum number of Assisted Living Program (ALP) beds allowed.
"current_census_alp", -- The total number of residents listed on the daily Census Report at 11:59 PM on December 31 who reside in the Assisted Living Program (ALP).
"alr_capacity_total", -- Refers to the maximum number of Assisted Living Residence (ALR) beds allowed.
"ages_81_census_total", -- The total number of residents aged 81 or greater on the Daily Census Report at 11:59 PM on December 31.
"current_census", -- The total number of residents listed on the Daily Census Report at 11:59 PM on December 31.
"male_census_total", -- The total number of male residents listed on the Daily Census Report at 11:59 PM on December 31.
"total_capacity" -- Refers to the maximum number of ACF beds allowed. These beds are certified by the NYSDOH under Article 7 of the New York State Public Health Law.
FROM
"health-data-ny-gov/adult-care-facility-annual-survey-20092012-u847-drrz:latest"."adult_care_facility_annual_survey_20092012"
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/adult-care-facility-annual-survey-20092012-u847-drrz 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/adult-care-facility-annual-survey-20092012-u847-drrz: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/adult-care-facility-annual-survey-20092012-u847-drrzCheckout 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/adult-care-facility-annual-survey-20092012-u847-drrz:latestThis will download all the objects for the latest tag of health-data-ny-gov/adult-care-facility-annual-survey-20092012-u847-drrz 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/adult-care-facility-annual-survey-20092012-u847-drrz: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/adult-care-facility-annual-survey-20092012-u847-drrz: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/adult-care-facility-annual-survey-20092012-u847-drrz is just another Postgres schema.