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 dwr_final_permit table in this repository, by referencing it like:
"colorado-gov/dwr-final-permit-4rcf-bncv:latest"."dwr_final_permit"or in a full query, like:
SELECT
":id", -- Socrata column ID
"location", -- Latitude/Longitude where the Final Permit well is permitted.
"expacres_approp", -- Limited annual appropriation when irrigating expanded acres (acre-feet).
"expacres_acres", -- Number of additional acres.
"expacres_priority", -- Priority date of final permit when irrigating expanded acres.
"commingled_wells", -- Other wells commingled. List of Well permits.
"commingled_authorization", -- Final Permit allows for commingled acres.
"acres", -- Number of acres which may be irrigated.
"appropriation", -- Maximum annual volume of appropriation. (acre-feet)
"utm_x", -- The x (Easting) component of the Universal Transverse Mercator system. (NAD83 datum)
"coordsns", -- Distance from north/south section line (feet).
"range", -- Range
"county", -- County where the Structure is located
"date_amended", -- Date Final Permit was amended
"date_issued", -- Date Final Permit was issued
"designated_basin", -- Designated Groundwater Basin in which the well is located
"coordsns_dir", -- Section line that distance measurement was taken from
"coordsew", -- Distance from east/west section line (feet).
"wd", -- Water District where the Structure is located.
"comment", -- Final Permit comments
"commingled_acres", -- Number of commingled acres
"commingled_approp", -- Commingled annual appropriation (acre-feet). Subject to individual well permit limits
"aquifer1", -- Aquifer(s) in which well can be completed
"pump_rate", -- Maximum pumping rate. (GPM)
"priority_date", -- Final permit priority date.
"utm_y", -- The y (Northing) component of the Universal Transverse Mercator system. (NAD83 datum)
"section", -- Section
"township", -- Township
"claimant", -- Final Permit Claimant
"div", -- Division where the Structure is located.
"aquifer_other", -- All other aquifer(s) that well can be completed
"aquifer2", -- Aquifer(s) in which well can be completed.
"q160", -- 160 acre quarter section indicator.
"permit_suf", -- Permit Suffix code
"permit_no", -- Permit Number
"location_zip",
"use1", -- Beneficial Uses for which the well can be used.
"management_district", -- Management District in which the well is located
"use2", -- Beneficial Uses for which the well can be used.
"altpt_authorization", -- Final Permit allows for alternate points for diversion.
"location_city",
"location_accuracy", -- Accuracy of UTM coordinates.
"flow_meter", -- Totalizing Flow meter installation requirement.
"location_address",
"q10", -- 10 acre quarter section indicator
"altpt_wells", -- Final Permit allows for alternate point diversions
"coordsew_dir", -- Section line that distance measurement was taken from
"expacres_authorized", -- Final Permit allows expanded acres
"location_state",
"q40", -- 40 acre quarter section indicator.
"special_use", -- Additional use, not necessarily beneficial, that help define what the well is
"status", -- Indicates the current status in the Final Permitting process.
":@computed_region_nku6_53ud",
"more_information", -- Hyperlink to more information about the Final Permit
"pm" -- Principle Meridian.
FROM
"colorado-gov/dwr-final-permit-4rcf-bncv:latest"."dwr_final_permit"
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 colorado-gov/dwr-final-permit-4rcf-bncv 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 colorado-gov/dwr-final-permit-4rcf-bncv: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 colorado-gov/dwr-final-permit-4rcf-bncvCheckout 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 colorado-gov/dwr-final-permit-4rcf-bncv:latestThis will download all the objects for the latest tag of colorado-gov/dwr-final-permit-4rcf-bncv 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 colorado-gov/dwr-final-permit-4rcf-bncv: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 colorado-gov/dwr-final-permit-4rcf-bncv: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, colorado-gov/dwr-final-permit-4rcf-bncv is just another Postgres schema.