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 economic_development_projects_closed table in this repository, by referencing it like:
"mydata-iowa-gov/economic-development-projects-closed-njr7-k88p:latest"."economic_development_projects_closed"or in a full query, like:
SELECT
":id", -- Socrata column ID
"project_maintenance_date", -- Date to which jobs were to be maintained. NA indicates the data was not available for the project - likely the result of changing program requirements.
"final_jobs_total", -- Sum of jobs created and retained including those below the contracted qualifying wage as verified at project maintenance date. NA indicates the data was not available for the project - likely the result of changing program requirements.
"final_jobs_other_created", -- Number of jobs created below contracted qualifying wage as verified at project maintenance date. NA indicates the data was not available for the project - likely the result of changing program requirements.
"final_jobs_retained", -- Number of jobs retained above contracted qualifying wage as verified at project maintenance date. NA indicates the data was not available for the project - likely the result of changing program requirements.
"final_jobs_created", -- Number of jobs created above contracted qualifying wage as verified at project maintenance date. NA indicates the data was not available for the project - likely the result of changing program requirements.
"project_completion_date", -- Date by which project, both investment and jobs, was completed. NA indicates the data was not available for the project - likely the result of changing program requirements.
"verified_total_project_cost", -- Verified actual total project cost at project completion. NA indicates the data was not available for the project - likely the result of changing program requirements.
"contracted_qualifying_wage", -- Contracted threshold/required wage as agreed to in the contract for contracted created and retained jobs. NA indicates the data was not available for the project - likely the result of changing program requirements.
"contracted_jobs_other", -- Number of other jobs to be created below contracted qualifying wage as noted in the contract. NA indicates the data was not available for the project - likely the result of changing program requirements.
"contracted_jobs_retained", -- Number of jobs to be retained above the contracted qualifying wage as agreed to in the contract. NA indicates the data was not available for the project - likely the result of changing program requirements.
"contracted_jobs_created", -- Number of jobs to be created above contracted qualifying wage as agreed to in the contract. NA indicates the data was not available for the project - likely the result of changing program requirements.
"projected_qualifying_wage", -- Projected threshold/required wage at time of award. NA indicates the data was not available for the project - likely the result of changing program requirements.
"projected_jobs_total", -- Sum of projected created, retained and other jobs. NA indicates the data was not available for the project - likely the result of changing program requirements.
"tax_benefits_awarded", -- Amount of maximum tax benefits awarded to company to complete project
"direct_assistance_awarded", -- Amount of direct assistance awarded to the company to complete project
"capital_investment", -- Total projected capital investment at time of award
"total_project_cost", -- Total projected cost of the project at time of award
"award_date", -- Date of award by IEDA Board
"primary_funding_agreement", -- If the project has more than one fund source, the primary funding agreement is displayed, or or in case of older awards, the funding source still open is displayed. The middle section of the agreement number indicates the direct assistance or tax credit program. See attachments in "About" panel for more information.
"city", -- City where the economic development project is located.
"county", -- Project location - county
"contracted_jobs_total", -- Sum of contracted created, retained and other jobs. NA indicates the data was not available for the project - likely the result of changing program requirements.
"projected_jobs_other", -- Number of other jobs projected at time of award which fall below the projected qualifying wage. NA indicates the data was not available for the project - likely the result of changing program requirements.
"projected_jobs_retained", -- Number of jobs projected to be retained above projected qualifying wage at time of award. NA indicates the data was not available for the project - likely the result of changing program requirements.
"projected_jobs_created", -- Number of jobs projected to be created above projected qualifying wage at time of award. NA indicates the data was not available for the project - likely the result of changing program requirements.
"contract_name", -- Name of company awarded assistance
"program", -- Names of economic development programs supporting the project.
"city_location", -- The location represents the city center for where the project is located, and not the exact project location.
"status", -- The status "Successful" indicates the project has met contractual requirements. The status "Full Recapture" indicates the project was unable to meet all terms required in the contract, and was required to pay back or return all direct assistance or tax credits awarded. The status "Partial Recapture" indicates the project was unable to meet all terms required in the contract, and was required to pay back or return a portion of the direct assistance or tax credits awarded.
":@computed_region_3r5t_5243",
":@computed_region_wnea_7qqw",
":@computed_region_i9mz_6gmt",
":@computed_region_e7ym_nrbf",
":@computed_region_uhgg_e8y2"
FROM
"mydata-iowa-gov/economic-development-projects-closed-njr7-k88p:latest"."economic_development_projects_closed"
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 mydata-iowa-gov/economic-development-projects-closed-njr7-k88p 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 mydata-iowa-gov/economic-development-projects-closed-njr7-k88p: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 mydata-iowa-gov/economic-development-projects-closed-njr7-k88pCheckout 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 mydata-iowa-gov/economic-development-projects-closed-njr7-k88p:latestThis will download all the objects for the latest tag of mydata-iowa-gov/economic-development-projects-closed-njr7-k88p 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 mydata-iowa-gov/economic-development-projects-closed-njr7-k88p: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 mydata-iowa-gov/economic-development-projects-closed-njr7-k88p: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, mydata-iowa-gov/economic-development-projects-closed-njr7-k88p is just another Postgres schema.