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
"wages_collected_by_bureau", -- The collection of wages is intended to deter employers' violations of, and increase compliance with Pennsylvania's labor laws.
"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.
"number_of_persons_successfully", -- This measure is a quantitative output of OVR's ability to address individual needs through a variety of services.
"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.
"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.
"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.
"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.
"number_of_participants_closed", -- This measure is an outcome of OVR's ability to prepare individuals with disabilities for a career.
"bureau_of_occupational_and", -- Fee collections are used to improve the department's ability to enforce occupational and industrial safety standards.
"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_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.
"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.
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.
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; sgr
can 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 clone
and sgr checkout
.
Cloning Data
Because pa-gov/governors-executive-budget-program-measures-sfy-7tik-q5zy: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/governors-executive-budget-program-measures-sfy-7tik-q5zy
Checkout 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/governors-executive-budget-program-measures-sfy-7tik-q5zy:latest
This will download all the objects for the latest
tag of pa-gov/governors-executive-budget-program-measures-sfy-7tik-q5zy
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/governors-executive-budget-program-measures-sfy-7tik-q5zy: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/governors-executive-budget-program-measures-sfy-7tik-q5zy:latest
This 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/governors-executive-budget-program-measures-sfy-7tik-q5zy
is just another Postgres schema.