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 workforce_innovation_and_opportunity_act_wioa table in this repository, by referencing it like:
"pa-gov/workforce-innovation-and-opportunity-act-wioa-kfaa-g3rs:latest"."workforce_innovation_and_opportunity_act_wioa"or in a full query, like:
SELECT
":id", -- Socrata column ID
"enddate", -- The last day of the program year
"metricresult_rates", -- The data value representing the outcome for the performance metrics that are expressed as a percent
"metricresult_wages", -- The data value representing the outcome for the performance metrics that are expressed as a dollar value
"programyear", -- The program year to which the performance metric applies
"address", -- The street address for the Local Workforce Development Board.
"zip_code", -- The zip code of the Local Workforce Development Board.
"state", -- The state of the Local Workforce Development Board.
"program", -- The program to which the performance metric applies
":@computed_region_nmsq_hqvv",
":@computed_region_d3gw_znnf",
":@computed_region_amqz_jbr4",
":@computed_region_rayf_jjgk",
":@computed_region_r6rf_p9et",
"city", -- The city of the Local Workforce Development Board.
"geocoded_column", -- The latitude and longitude for the location of the Local Workforce Development Board.
"metricname", -- The name of the performance metric: Employment Rate (Q2) is the percentage of participants who are in unsubsidized employment during the second quarter after exit from the program (for title I Youth, the indicator is the percentage of participants in education or training activities, or in unsubsidized employment during the second quarter after exit – Employment, Education, or Training Placement Rate (Q2)), Employment Rate (Q4) is the percentage of participants who are in unsubsidized employment during the fourth quarter after exit from the program (for title I Youth, the indicator is the percentage of participants in education or training activities, or in unsubsidized employment during the fourth quarter after exit – Employment, Education, or Training Placement Rate (Q4)), the Median Earnings is the median earnings of participants who are in unsubsidized employment during the second quarter after exit from the program, the Credential Rate is the percentage of those participants enrolled in an education or training program (excluding those in on-the-job training (OJT) and customized training) who attain a recognized postsecondary credential or a secondary school diploma, or its recognized equivalent, during participation in or within one year after exit from the program. A participant who has attained a secondary school diploma or its recognized equivalent is included in the percentage of participants who have attained a secondary school diploma or its recognized equivalent only if the participant also is employed or is enrolled in an education or training program leading to a recognized postsecondary credential within one year after exit from the program, and lastly the Measurable Skill Gains is the percentage of program participants who, during a program year, are in an education or training program that leads to a recognized postsecondary credential or employment and who are achieving measurable skill gains, defined as documented academic, technical, occupational, or other forms of progress, towards such a credential or employment. Depending on the type of education or training program, documented progress is defined as one of the following: 1. Documented achievement of at least one educational functioning level of a participant who is receiving instruction below the postsecondary education level; 2. Documented attainment of a secondary school diploma or its recognized equivalent; 3. Secondary or postsecondary transcript or report card for a sufficient number of credit hours that shows a participant is meeting the State unit's academic standards; 4. Satisfactory or better progress report, towards established milestones, such as completion of OJT or completion of one year of an apprenticeship program or similar milestones, from an employer or training provider who is providing training; or 5. Successful passage of an exam that is required for a particular occupation or progress in attaining technical or occupational skills as evidenced by trade-related benchmarks such as knowledge-based exams.
"workforce_development_area" -- The name of the workforce development area to which the performance metric applies
FROM
"pa-gov/workforce-innovation-and-opportunity-act-wioa-kfaa-g3rs:latest"."workforce_innovation_and_opportunity_act_wioa"
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/workforce-innovation-and-opportunity-act-wioa-kfaa-g3rs 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/workforce-innovation-and-opportunity-act-wioa-kfaa-g3rs: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/workforce-innovation-and-opportunity-act-wioa-kfaa-g3rsCheckout 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/workforce-innovation-and-opportunity-act-wioa-kfaa-g3rs:latestThis will download all the objects for the latest tag of pa-gov/workforce-innovation-and-opportunity-act-wioa-kfaa-g3rs 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/workforce-innovation-and-opportunity-act-wioa-kfaa-g3rs: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/workforce-innovation-and-opportunity-act-wioa-kfaa-g3rs: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/workforce-innovation-and-opportunity-act-wioa-kfaa-g3rs is just another Postgres schema.