datahub-austintexas-gov/issued-signbanner-permits-8wgz-z8nv
Icon for Socrata external plugin

Query the Data Delivery Network

Query the DDN

The 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_signbanner_permits table in this repository, by referencing it like:

"datahub-austintexas-gov/issued-signbanner-permits-8wgz-z8nv:latest"."issued_signbanner_permits"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "geocoded_column",
    "applicant_organization", -- An organization associated with this permit (note: not always tied to applicant)
    "zip_code", -- Zip code of associated property
    "installation_date", -- When is the sign/banner set to be installed.
    "state", -- State of associated property
    "sign_variance_req", -- Was a sign variance required to gain this permit?
    "illumination_type", -- Does it have external or interal illumination characteristics?
    "permit_status", -- Status of the current permit.
    ":@computed_region_8spj_utxs",
    "permit_id", -- ID associated with the permit application within the AMANDA database.
    "latitude", --  Latitude of associated property
    "permit_in_date", -- When the permit for the sign was first applied.
    "permit_location_name", -- If available, the address or general location of where the permit applies.
    ":@computed_region_jcrc_4uuy",
    "fiscal_year", -- The fiscal year (starting Oct 1) this permit was applied for.
    ":@computed_region_q9nd_rr82",
    ":@computed_region_e9j2_6w3z",
    "total_sign_face_area", -- The total sign's area on its face
    "permit_final_date", -- Sometimes used to describe the end date for when the permit is no longer applicable.
    "permit_number", -- Number of permit (including type)
    ":@computed_region_m2th_e4b7",
    ":@computed_region_rxpj_nzrk",
    "permit_description", -- Description of the sign/banner.
    "permit_sub_type", -- Describes if this is this a sign or banner.
    "city", -- City of associated property
    "permit_expire_date", -- When the permit is no longer applicable.
    "sign_in_etj", -- Is this sign within the Austin ETJ?
    "banner_location", -- If this is a banner, what is the street address of where it will hang.
    "longitude", -- Longitude of associated property
    "calendar_year", -- The calendar year this permit was applied for.
    "permit_condition", -- Added conditions applied to the permit, such as restrictions.
    "council_district", -- Council District of associated property
    "submitted_501c3", -- Was a 501c3 Form submitted with this permit?
    "banner_direction", -- If this is a banner, which direction is it facing.
    "permit_work_type", -- Describes more details about the type of sign or banner: lamp post, wall, awning, projection, etc.
    "engineering_req", -- Will this require engineering efforts?
    "removal_date", -- When is the sign/banner set to be removed.
    "permit_parent_id", -- This number represents associated projects with the permit's application within the AMANDA database. 
    "applicant_name" -- The applicant associated with this permit
FROM
    "datahub-austintexas-gov/issued-signbanner-permits-8wgz-z8nv:latest"."issued_signbanner_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-signbanner-permits-8wgz-z8nv with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at datahub.austintexas.gov. When you querydatahub-austintexas-gov/issued-signbanner-permits-8wgz-z8nv: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

Install Splitgraph Locally
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 datahub.austintexas.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 \
  "datahub-austintexas-gov/issued-signbanner-permits-8wgz-z8nv" \
  --handler-options '{
    "domain": "datahub.austintexas.gov",
    "tables": {
        "issued_signbanner_permits": "8wgz-z8nv"
    }
}'

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, datahub-austintexas-gov/issued-signbanner-permits-8wgz-z8nv is just another Postgres schema.