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 asset_management_parks_system_amps_work_orders table in this repository, by referencing it like:
"cityofnewyork-us/asset-management-parks-system-amps-work-orders-8sdw-8vja:latest"."asset_management_parks_system_amps_work_orders"or in a full query, like:
SELECT
":id", -- Socrata column ID
"evt_udfchar04", -- Indicate asset type
"evt_target", -- Scheduled completion date
"evt_date", -- Date the work order was created
"evt_udfchar05", -- Reason for rejection, for rejected WO
"evt_udfchar03", -- Indicates group this work order is submitted to
"evt_freq", -- Frequency of planned preventative maintenance
"evt_standwork", -- Work order standard type.
"evt_completed", -- Date and time this work order was completed.
"evt_mrc", -- The name of the Park maintenance district in which the property is located.
"evt_ppm", -- Property where planned preventative maintenance occurred.
"evt_udfchkbox05", -- Indicates if a document is attached to work order
"evt_udfnum01", -- Scheduling sequence
"evt_udfchar06", -- Trade of person assigned to the work order
"evt_udfchar02", -- Subclass of work order for data modification requests
"evt_udfchar01", -- Requested priority of the work order
"evt_due", -- Scheduled due date
"evt_reported", -- Editable date reported, when date was entered into system
"evt_jobtype", -- Type of work order job
"evt_route", -- Indicates what should be inspected at a given site
"evt_class", -- Work Order Class
"evt_reopened", -- Indicates is work order was completed and reopened
"evt_udfchkbox04", -- Indicates if a comment is attached to work order
"evt_warranty", -- Indicates if equipment was repair was covered under warranty
"evt_priority", -- Assigned priority of the work order
"evt_printed", -- Indicates if the work order has been printed
"evt_udfchkbox02", -- Indicates if new part
"evt_safety", -- Indicates if the work order is safety related
"evt_obtype", -- Object type
"evt_updatecount", -- Number of times the work order record has been updated
"evt_desc", -- Work Order Description
"evt_udfchar12", -- Indicates if work request was generated on a phone or desktop
"evt_udfchar08", -- Street location of park/asset, if available
"evt_completed_trunc", -- Date for when work order was closed
"evt_udfchar13", -- Current status of work order
"evt_udfchar10", -- Parks Inspection feature that work order pertains to
"evt_schedend", -- Scheduled end time for a scheduled work order
"evt_start", -- Date work order status (EVT_UDFCHAR13) is first changed to "Open"
"evt_reqm", -- Problem Code
"evt_udfchar14", -- Date inspection was uploaded
"evt_sqlidentity", -- Unique identifier
"evt_created", -- Date and time this work order was created
"evt_parent", -- Work order number (EVT_CODE) of this work order's "parent" work order, as applicable
"evt_udfnum02",
"evt_perioduom", -- Period of scheduled task
"evt_udfchkbox01", -- Indicates if work order is generated from a Daily Immediate Attention (DIA)
"evt_type", -- Work Order Type
"evt_udfchar11", -- Indicates if out of service or salvaged
"evt_isstype", -- Recurrence schedule for planned preventative maintenance
"evt_updated", -- Date and time this work order was last updated
"evt_duration", -- Indicates expected time to complete scheduled task (in days)
"evt_object", -- ID number for the park or asset the work order is written about
"evt_code", -- Unique ID for each work order
"evt_multiequip", -- Indicates if work order is for multiple pieces of equipment
"evt_udfchkbox03", -- Reviewed for backlog cleanup
"evt_udfchar16", -- 311 service request number
"evt_udfchar15" -- Daily Immediate Attention (DIA) number
FROM
"cityofnewyork-us/asset-management-parks-system-amps-work-orders-8sdw-8vja:latest"."asset_management_parks_system_amps_work_orders"
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 cityofnewyork-us/asset-management-parks-system-amps-work-orders-8sdw-8vja 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 cityofnewyork-us/asset-management-parks-system-amps-work-orders-8sdw-8vja: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 cityofnewyork-us/asset-management-parks-system-amps-work-orders-8sdw-8vjaCheckout 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 cityofnewyork-us/asset-management-parks-system-amps-work-orders-8sdw-8vja:latestThis will download all the objects for the latest tag of cityofnewyork-us/asset-management-parks-system-amps-work-orders-8sdw-8vja 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 cityofnewyork-us/asset-management-parks-system-amps-work-orders-8sdw-8vja: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 cityofnewyork-us/asset-management-parks-system-amps-work-orders-8sdw-8vja: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, cityofnewyork-us/asset-management-parks-system-amps-work-orders-8sdw-8vja is just another Postgres schema.