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 issued_tree_permits table in this repository, by referencing it like:
"datahub-austintexas-gov/issued-tree-permits-ac2h-ha3r:latest"."issued_tree_permits"or in a full query, like:
SELECT
":id", -- Socrata column ID
"issued_date", -- date the permit was issued
"expires_date", -- date the permit is set to expire
"property_id", -- ID associated with property within the AMANDA database
"trunk_diameter", -- Diameter of tree trunk
"appendix_f_removed", -- Sums of diameter trunk inches of trees that appear in the Environmental Criteria Manual Appendix F (table of desirable tree species)
"latitude", -- Geographic coordinate that specifies the north–south position of a point on the Earth's surface, in degrees.
"link_to_details", -- More information to be found on the Austin Build and Connect portal
"removal_of_regulated_tree", -- Does this permit involve removal of a regulated tree? (Yes/No)
"public_tree", -- Is this tree considered public? (Yes/No)
"propy", -- Location information on TX State Plane (Y-Value)
"jurisdiction", -- The city jurisdiction (e.g. Full Purpose, ETJ, etc.) of this permit
"project_id", -- ID associated with the permit application within the AMANDA database
"non_appendix_f_removed", -- Sums of diameter trunk inches of trees that do not appear in the Environmental Criteria Manual Appendix F (table of desirable tree species) or are considered invasive.
"mitigation", -- The mitigation inches planted onsite
"council_district", -- Council District number for the location of the tree
"combined_geo",
"encroachment_of_root_zone", -- Does this permit involve encroaching on the root zone? (Yes/No)
"tree_condition", -- The condition of tree at time of permit (e.g. dead, good, fair, etc)
"crown_removal", -- Does this permit require crown removal? (Yes/No)
"species", -- Species of associated tree(s)
"fee_required", -- Is there a fee associated with this permit? (Yes/No)
"heritage_tree", -- Is this a heritage tree? (Yes/No)
"application_type", -- Is this tree related to a development review process
"permit_class", -- Residential, Commercial, or Public class of permit
":@computed_region_rxpj_nzrk", -- This column was automatically created in order to record in what polygon from the dataset 'Zipcodes' (rxpj-nzrk) the point in column 'combined_geo' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"permit_address", -- Address associated with permit
":@computed_region_m2th_e4b7", -- This column was automatically created in order to record in what polygon from the dataset 'Community Registry' (m2th-e4b7) the point in column 'combined_geo' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
":@computed_region_e9j2_6w3z", -- This column was automatically created in order to record in what polygon from the dataset 'Neighborhood Planning Areas' (e9j2-6w3z) the point in column 'combined_geo' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
":@computed_region_q9nd_rr82", -- This column was automatically created in order to record in what polygon from the dataset 'BOUNDARIES_single_member_districts' (q9nd-rr82) the point in column 'combined_geo' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"propx", -- Location information on TX State Plane (X-Value)
":@computed_region_jcrc_4uuy", -- This column was automatically created in order to record in what polygon from the dataset 'Boundaries: Zip Code Tabulation Areas, 2017' (jcrc-4uuy) the point in column 'combined_geo' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
":@computed_region_8spj_utxs", -- This column was automatically created in order to record in what polygon from the dataset 'Single Member Council Districts' (8spj-utxs) the point in column 'combined_geo' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"longitude", -- Geographic coordinate that specifies the east–west position of a point on the Earth's surface, in degrees
"permit_number", -- Number of permit (including type)
"reason_for_request", -- Reason for permit request
"permit_status" -- current status of the permit
FROM
"datahub-austintexas-gov/issued-tree-permits-ac2h-ha3r:latest"."issued_tree_permits"
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 datahub-austintexas-gov/issued-tree-permits-ac2h-ha3r 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 datahub-austintexas-gov/issued-tree-permits-ac2h-ha3r: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 datahub-austintexas-gov/issued-tree-permits-ac2h-ha3rCheckout 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 datahub-austintexas-gov/issued-tree-permits-ac2h-ha3r:latestThis will download all the objects for the latest tag of datahub-austintexas-gov/issued-tree-permits-ac2h-ha3r 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 datahub-austintexas-gov/issued-tree-permits-ac2h-ha3r: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 datahub-austintexas-gov/issued-tree-permits-ac2h-ha3r: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, datahub-austintexas-gov/issued-tree-permits-ac2h-ha3r is just another Postgres schema.