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 dsd_planning_zoning_and_design_review_memos
table in this repository, by referencing it like:
"citydata-mesaaz-gov/dsd-planning-zoning-and-design-review-memos-u5a9-tj5y:latest"."dsd_planning_zoning_and_design_review_memos"
or in a full query, like:
SELECT
":id", -- Socrata column ID
"rowid", -- Unique Row Identifier
"record_id", -- System generated permit number
"record_type", -- Type of permit (e.g. Residential)
"permit_description", -- Description of work
"record_open_date", -- Date record opened
"record_status_date", -- Effective date of current status
"record_status", -- Current status of record
"submission_deadline_date", -- Submission Deadline Date
"distributed_date", -- Distributed Date
"formal_submittal_deadline_date", -- Formal Submittal Deadline Date
"review_consolidation_date", -- Review Consolidation date
"task", -- Current workflow task
"task_status", -- Status of current workflow task
"record_status_month", -- Effective month of current status
"record_status_year", -- Effective year of current status
"review_days", -- Number of days a record is under review
"reviewed_15days", -- Answers question "Was memo completed in 15 days?" 1=yes, 0=no
"record_count", -- Always a '1', system generated, not a useful field
"assigned_user", -- City employee assigned to work on application
"permit_address", -- Address on permit application where work will be done
"street_number", -- Street number of permit address
"street_direction", -- Street direction of permit address
"street_address", -- Street address of permit address
"street_name", -- Street name of permit address
"street_suffix", -- Street suffix of permit address
"latitude", -- System generated latitude of permit address
"longitude", -- System generated longitude of permit address
"location" -- Geocoded location of permit address
FROM
"citydata-mesaaz-gov/dsd-planning-zoning-and-design-review-memos-u5a9-tj5y:latest"."dsd_planning_zoning_and_design_review_memos"
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 citydata-mesaaz-gov/dsd-planning-zoning-and-design-review-memos-u5a9-tj5y
with SQL in under 60 seconds.
This repository is an "external" repository. That means it's hosted elsewhere, in this case at citydata.mesaaz.gov. When you querycitydata-mesaaz-gov/dsd-planning-zoning-and-design-review-memos-u5a9-tj5y: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; sgr
can 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 clone
and sgr checkout
.
Mounting Data
This repository is an external repository. It's not hosted by Splitgraph. It is hosted by citydata.mesaaz.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 \
"citydata-mesaaz-gov/dsd-planning-zoning-and-design-review-memos-u5a9-tj5y" \
--handler-options '{
"domain": "citydata.mesaaz.gov",
"tables": {
"dsd_planning_zoning_and_design_review_memos": "u5a9-tj5y"
}
}'
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, citydata-mesaaz-gov/dsd-planning-zoning-and-design-review-memos-u5a9-tj5y
is just another Postgres schema.