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 governors_executive_budget_program_measures_sfy table in this repository, by referencing it like:
"pa-gov/governors-executive-budget-program-measures-sfy-7tik-q5zy:latest"."governors_executive_budget_program_measures_sfy"or in a full query, like:
SELECT
":id", -- Socrata column ID
"number_of_free_workplace", -- This number is one of two quantitative inputs to assess the yearly performance of the Bureau of Workers' Compensation through the frequency of workplace safety and health training and outreach events.
"number_of_participants_closed", -- This measure is an outcome of OVR's ability to prepare individuals with disabilities for a career.
"employment_rate_for_youth", -- This measure assesses the impact of WIOA funds in improving employment outcomes for youth beneficiaries.
"number_of_attendees_at", -- This number is one of two quantitative inputs to assess the yearly performance of the Bureau of Workers' Compensation through the total number of individuals trained through various workplace safety and health training and outreach events.
"number_of_registered", -- This measure provides an output of the department's efforts to support the recruitment and development of a high-skilled workforce, benefitting both employers and apprentices.
"number_of_persons_successfully", -- This measure is a quantitative output of OVR's ability to address individual needs through a variety of services.
"percentage_of_first_payments", -- A higher percentage in this measure reflects the department's ability to provide faster payments to eligible claims, thereby improving services for claimants and employers.
"wages_collected_by_bureau", -- The collection of wages is intended to deter employers' violations of, and increase compliance with Pennsylvania's labor laws.
"number_of_workplace_injury", -- This measure provides one way to assess the effectiveness outcome of safety and health training and outreach initiatives from the Bureau of Workers' Compensation to reduce the number of Pennsylvania's workplace injury fatalities.
"employment_rate_for_adult", -- This measure assesses the impact of WIOA funds in improving employment outcomes for adult beneficiaries.
"number_of_eligible", -- This measure is a quantitative output of the Office of Vocational Rehabilitation's core mission to enroll eligible individuals with disabilities in services so that they can prepare for, obtain, or maintain employment.
"bureau_of_occupational_and", -- Fee collections are used to improve the department's ability to enforce occupational and industrial safety standards.
"percentage_of_eligibility", -- A higher percentage in this measure reflects the department's ability to issue faster eligibility determinations for UC claimants, thereby improving services for claimants and employers.
"fiscal_year", -- Fiscal year for which the program measure values in this row are applicable. Fiscal Years 2020-21 and 2021-22 are estimated amounts based on agency projections.
"budget_book_budget_year", -- This is the State Fiscal Year when the program measure numbers in this row were submitted for the Governor's Executive Budget Book.
"students_receiving_pre", -- This measure is a quantitative output of the performance of Pre-ETS. OVR is required to set aside at least 15% of its federal funds to provide Pre-ETS statewide to all students with disabilities who are eligible or potentially eligible for VR services.
"customers_receiving_financial" -- This measure is a quantitative input in assessing the financial resources that OVR provides yearly to eligible customers.
FROM
"pa-gov/governors-executive-budget-program-measures-sfy-7tik-q5zy:latest"."governors_executive_budget_program_measures_sfy"
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/governors-executive-budget-program-measures-sfy-7tik-q5zy 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/governors-executive-budget-program-measures-sfy-7tik-q5zy: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/governors-executive-budget-program-measures-sfy-7tik-q5zy" \
--handler-options '{
"domain": "data.pa.gov",
"tables": {
"governors_executive_budget_program_measures_sfy": "7tik-q5zy"
}
}'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/governors-executive-budget-program-measures-sfy-7tik-q5zy is just another Postgres schema.