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-m3tg-4ehd:latest"."governors_executive_budget_program_measures_sfy"
or in a full query, like:
SELECT
":id", -- Socrata column ID
"homes_weatherized", -- The number of occupied single family or multi-family dwellings that received program services designed to make housing more affordable to low income families by cutting their heating costs and improving living conditions.
"municipal_assistance_program", -- The number of municipalities receiving financial assistance through the Municipal Assistance Program.
"keystone_communities_projects", -- The number of Keystone Community program grants projects financed, that supports such activities as planning, operations, downtown reinvestment, and anchor building in Pennsylvania communities.
"strategic_management_planning", -- These are the number of municipalities receiving financial and technical assistance through the Strategic Management Planning Program.
"foreign_direct_investments", -- The number of successfully completed international investment projects facilitated by the Office of International Business Development (OIBD).
"private_funds_leveraged_in_1", -- Private investments or matching funds on a DCED Technology Investment Office’s programs funded project, including venture capital, private equity invested, first time funding, and follow-on funding.
"new_technology_companies", -- Technology companies formed within three years of having received funds from DCED Technology Investment Office’s programs.
"businesses_assisted", -- Businesses which have received funding or technical assistance through a project or program from the Department.
"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.
"travelers_expenditures_in", -- An estimate of the amount of money visitors spend during a visit to or within Pennsylvania.
"number_of_hotel_rooms_sold", -- The number of hotel rooms sold in Pennsylvania per year as reported by Smith Travel Research (STR). STR provides premium data benchmarking, analytics, and marketplace insights for global hospitality sectors.
"businesses_assisted4", -- The number of businesses accessing the services and programs offered by the Office of International Business Development (OIBD).
"jobs_supported", -- The estimated number of jobs directly related to Office of International Businesses Development export and foreign direct investments assistance to companies.
"amount_of_export_sales", -- Export sales facilitated are companies’ export sales generated that are directly attributed to financial and technical assistance from the Office of International Business Development (OIBD).
"estimated_state_and_local", -- The estimated state and local tax revenues generated as result of export sales and foreign direct investments facilitated by the Office of International Business Development (OIBD).
"jobs_created", -- Full time jobs or positions added to company’s’ payroll as a direct result of funding through DCED Technology Investment Office’s programs.
"number_of_trainings_to_pa", -- Trainings offered to Pennsylvania residents to obtain or retain employment, through programs funded by the Department.
"private_funds_leveraged_in", -- Private funds leveraged are private investments or matching funds on a Department’s funded project.
"jobs_pledged_to_be_retained", -- Jobs pledged to be retained are legally binding pledges by companies to preserve permanent, full-time positions on the company’s payroll, paying at least 150% over the federal minimum wage, as a direct result of funding received from the Department.
"jobs_pledged_to_be_created", -- Jobs pledged to be created are legally binding pledges by companies to add permanent, full-time positions on company’s payroll, paying at least 150% over the federal minimum wage, as a direct result of funding received from the Department.
"businesses_assisted2", -- Businesses which have received funding or technical assistance through a project or program of DCED Technology Investment Office.
"jobs_retained", -- Full time jobs or positions preserved by companies as a direct result of funding through DCED Technology Investment Office’s programs.
"tax_revenues_generated_in", -- The estimate of total state tax and local revenues generated by visitor spending, including hotel rooms, car rentals, entertainment expenditures, shopping, and food service.
"number_of_designated" -- The number of designated distressed municipalities receiving technical and/or financial assistance under the Act 47 program.
FROM
"pa-gov/governors-executive-budget-program-measures-sfy-m3tg-4ehd: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-m3tg-4ehd
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-m3tg-4ehd: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-m3tg-4ehd
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-m3tg-4ehd:latest
This will download all the objects for the latest
tag of pa-gov/governors-executive-budget-program-measures-sfy-m3tg-4ehd
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-m3tg-4ehd: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-m3tg-4ehd: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-m3tg-4ehd
is just another Postgres schema.