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_under_contract table in this repository, by referencing it like:
"mydata-iowa-gov/economic-development-projects-under-contract-g6gr-2p55:latest"."economic_development_projects_under_contract"or in a full query, like:
SELECT
":id", -- Socrata column ID
"date_reported", -- Annual report cut off date
"reported_jobs_total", -- Sum of jobs created and retained including those below the contracted qualifying wage as of the annual report cut-off date. Data only available for projects in "maintenance" period. NA indicates the data was not available for the project - likely the result of changing program requirements.
"reported_jobs_other_created", -- Number of jobs created below the contracted qualifying wage as of the annual report cut-off date. Data only available for projects in the "maintenance" period. NA indicates the data was not available for the project - likely the result of changing program requirements.
"reported_jobs_created", -- Number of jobs created above contracted qualifying wage as of the annual report cut-off date. Data only available for projects in the "maintenance" period. NA indicates the data was not available for the project - likely the result of changing program requirements.
"project_completion_jobs_total", -- Sum of jobs created and retained including those below the contracted qualifying wage as verified at project completion. Data only available for projects in "maintenance" period. NA indicates the data was not available for the project - likely the result of changing program requirements.
"project_completion_jobs_created", -- Number of jobs created above contracted qualifying wage as verified at project completion. Data only available for projects in "maintenance" period. 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_created", -- 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.
"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.
"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.
"direct_assistance_awarded", -- Amount of direct assistance awarded to the company to complete project
"primary_funding_agreement", -- 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", -- Name of the city the project is located in.
"county", -- Project location - county
"contract_name", -- Name of company awarded assistance
"project_maintenance_date", -- Date to which jobs are to be maintained
"reported_jobs_retained", -- Number of jobs retained above contracted qualifying wage as of the annual report cut-off date. Data only available for projects in the "maintenance" period. 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 or anticipated to be completed.
"total_project_cost_project_completion", -- Verified actual total project cost at project completion. Data only available for projects in "maintenance" period. NA indicates the data was not available for the project - likely the result of changing program requirements.
"project_completion_jobs_other_created", -- Number of other jobs created that were below contracted qualifying wage as verified at project completion. Data only available for projects in "maintenance" period. NA indicates the data was not available for the project - likely the result of changing program requirements.
"project_completion_jobs_retained", -- Number of jobs retained above contracted qualifying wage as verified at project completion. Data only available for projects in "maintenance" period. 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_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.
"total_project_cost", -- Total projected cost of the project at time of award
"award_date", -- Date of award by IEDA Board
"program", -- Names of economic development programs supporting the project.
"status", -- The status "Performance" represent projects in the performance period that are under contract and still being implemented. The status "Maintenance" represent projects that are completed, but are required to maintain the obligated jobs and investment through the “Maintenance Date.” The status “in default” is a temporary one since businesses are allowed a contractually designated cure period to correct the default. Reasons for being considered “in default” range from not filing required reports to not creating the obligated jobs or investment required by the contract. Status is as of the report date.
"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.
"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.
"tax_benefits_awarded", -- Amount of maximum tax benefits awarded to company to complete project
"capital_investment", -- Total projected capital investment at time of award
"city_location", -- Primary coordinates for the city the project is located in. Does not represent the location of the project itself.
":@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-under-contract-g6gr-2p55:latest"."economic_development_projects_under_contract"
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-under-contract-g6gr-2p55 with SQL in under 60 seconds.
This repository is an "external" repository. That means it's hosted elsewhere, in this case at mydata.iowa.gov. When you querymydata-iowa-gov/economic-development-projects-under-contract-g6gr-2p55: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 mydata.iowa.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 \
"mydata-iowa-gov/economic-development-projects-under-contract-g6gr-2p55" \
--handler-options '{
"domain": "mydata.iowa.gov",
"tables": {
"economic_development_projects_under_contract": "g6gr-2p55"
}
}'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, mydata-iowa-gov/economic-development-projects-under-contract-g6gr-2p55 is just another Postgres schema.