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 persons_aged_21_64_with_disabilities_enrolled_with table in this repository, by referencing it like:
"pa-gov/persons-aged-21-64-with-disabilities-enrolled-with-9rbq-ar2n:latest"."persons_aged_21_64_with_disabilities_enrolled_with"or in a full query, like:
SELECT
":id", -- Socrata column ID
"confirmed_cie", -- Total unique HCBS participants.
"half_calender_year", -- Full Calender year
"hcbs_authorizations", -- A participant's PCSP had one of the defined employment services on their PCSP during the reporting month. For this data element, the CHC-MCO should indicate if the employment service is being provided by the MCO. Authorizations includes following employment services provided by MCO: (1) Benefits Counseling , (2) Career Assessment, (3) Employment Skills Development, (4) Job Finding, and (5) Job Finding. Note: Values from 1-10 are suppressed with use of '*' for confidentiality reasons / total unique HCBS participants.
"number_with_employment_services_authorized", -- Number with Employment Services Authorized
"chc_mco_s", -- Community HealthChoices Managed Care Organizations (CHC MCOs). AHC/KF - AmeriHealth Caritas / Keystone First; PHW - Pennsylvania Health & Wellness; UPMC - University of Pittsburgh Medical Center
"employed_count", -- Number employed. Note: Values from 1-10 are suppressed with use of '*' for confidentiality reasons
"total_unique_hcbs_participants", -- Community Health Choices (CHC) Home and Community Based Serivces (HCBS) waiver participants for particular age group are derived from quarterly standard enrollment report using distinct count logic. Age is calculated based on the first day of the period to capture people who were 64 but turned 65 within that period.
"goal_documented_on_pcsp_count", -- The participant had employment as a goal documented on their Personal Care Services Program (PCSP) during the reporting month. Note: This ties to the following PCSP checklist question, "Does the PCSP address short and long term goals?" Note: Values from 1-10 are suppressed with use of '*' for confidentiality reasons
"goal_documented_on_pcsp", -- The participant had employment as a goal documented on their Personal Care Services Program (PCSP) during the reporting month. Note: This ties to the following PCSP checklist question, "Does the PCSP address short and long term goals?" Note: Values from 1-10 are suppressed with use of '*' for confidentiality reasons / total unique HCBS participants.
"hcbs_authorizations_count", -- A participant's PCSP had one of the defined employment services on their PCSP during the reporting month. For this data element, the CHC-MCO should indicate if the employment service is being provided by the MCO. Authorizations includes following employment services provided by MCO: (1) Benefits Counseling , (2) Career Assessment, (3) Employment Skills Development, (4) Job Finding, and (5) Job Finding. Note: Values from 1-10 are suppressed with use of '*' for confidentiality reasons
"percentage_with_employment_services_authorized", -- Percentage with Employment Services Authorized
"employed", -- Number employed. Note: Values from 1-10 are suppressed with use of '*' for confidentiality reasons / total unique HCBS participants.
"confirmed_cie_count" -- The CHC-MCO must use the following definition for Competitive Integrated Employment: Work performed on a full or part-time basis (including self-employment) for which a person is: (1) Compensated at not less than federal minimum wage requirements or State or local minimum wage law (whichever is higher); (2) At a location where the employee interacts with people without a disability (not including supervisory personnel or people who are providing services to such employee); and (3) Presented, as appropriate, opportunities for similar benefits and advancement like those for other employees without a disability and who have similar positions. Note: The total number of hours employed is reported as disclosed by the participant. Note: Values from 1-10 are suppressed with use of '*' for confidentiality reasons
FROM
"pa-gov/persons-aged-21-64-with-disabilities-enrolled-with-9rbq-ar2n:latest"."persons_aged_21_64_with_disabilities_enrolled_with"
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 pa-gov/persons-aged-21-64-with-disabilities-enrolled-with-9rbq-ar2n 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 pa-gov/persons-aged-21-64-with-disabilities-enrolled-with-9rbq-ar2n: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 pa-gov/persons-aged-21-64-with-disabilities-enrolled-with-9rbq-ar2nCheckout 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 pa-gov/persons-aged-21-64-with-disabilities-enrolled-with-9rbq-ar2n:latestThis will download all the objects for the latest tag of pa-gov/persons-aged-21-64-with-disabilities-enrolled-with-9rbq-ar2n 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 pa-gov/persons-aged-21-64-with-disabilities-enrolled-with-9rbq-ar2n: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 pa-gov/persons-aged-21-64-with-disabilities-enrolled-with-9rbq-ar2n: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, pa-gov/persons-aged-21-64-with-disabilities-enrolled-with-9rbq-ar2n is just another Postgres schema.