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.
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-m3tg-4ehd: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-m3tg-4ehd" \
--handler-options '{
"domain": "data.pa.gov",
"tables": {
"governors_executive_budget_program_measures_sfy": "m3tg-4ehd"
}
}'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-m3tg-4ehd is just another Postgres schema.