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
"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
"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", -- Number employed. Note: Values from 1-10 are suppressed with use of '*' for confidentiality reasons / total unique HCBS participants.
"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.
"half_calender_year", -- Half Calender year
"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
"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.
"employed_count", -- Number employed. 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.
"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
"confirmed_cie" -- / total unique HCBS participants.
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.
This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.pa.gov. When you querypa-gov/persons-aged-21-64-with-disabilities-enrolled-with-9rbq-ar2n: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.pa.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 \
"pa-gov/persons-aged-21-64-with-disabilities-enrolled-with-9rbq-ar2n" \
--handler-options '{
"domain": "data.pa.gov",
"tables": {
"persons_aged_21_64_with_disabilities_enrolled_with": "9rbq-ar2n"
}
}'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, pa-gov/persons-aged-21-64-with-disabilities-enrolled-with-9rbq-ar2n is just another Postgres schema.