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 transportation_pavement_inventory table in this repository, by referencing it like:
"citydata-mesaaz-gov/transportation-pavement-inventory-2gx3-zdvf:latest"."transportation_pavement_inventory"or in a full query, like:
SELECT
":id", -- Socrata column ID
"condition_year", -- Year the pavement condition was surveyed
"condition", -- Weighted Average Pavement Condition Index (PCI) as measured on a scale of 1 to 100 where 100 is best. PCI is used to indicate the general condition of a pavement, is a statistical measure and requires manual survey of the pavement.
"link_key", -- This field is a unique ID created by the City of Mesa for each roadway and area of pavement maintained by the City of Mesa. The Link Key is classified by street type: arterial, collector, dirt road, intersection, parking lot, miscellaneous, other, paved alley, residential, unpaved alley, retired.
"condition_date", -- Date the pavement condition was surveyed
"is_active", -- This field indicates whether the section of roadway or parking area is currently being maintained by the City of Mesa.
"shape_length", -- This field indicates the length of the line feature in feet.
"condition_month", -- Month the pavement condition was surveyed
"object_id", -- This field is a computer-generated unique ID.
"facility_id", -- This field is a computer-generated unique identifier used for Cityworks, which is our work management system.
"location", -- This field identifies the name and boundaries of the section of roadway or paved area.
"global_id", -- This field is an ArcGIS System Generated ID.
"sweep_by", -- This field indicates who this section of roadway is swept by: City of Mesa, Contractor, or Facilities.
"sweep_id", -- This field indicates the sweeping route that this section of roadway or paved area is assigned to.
"intersection_type", -- This field describes the type of intersection: Decorative Full, Decorative Partial, Painted Bike Facility.
"geometry" -- Geo location of line segment. From GIS attributes
FROM
"citydata-mesaaz-gov/transportation-pavement-inventory-2gx3-zdvf:latest"."transportation_pavement_inventory"
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/transportation-pavement-inventory-2gx3-zdvf 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 citydata-mesaaz-gov/transportation-pavement-inventory-2gx3-zdvf: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 citydata-mesaaz-gov/transportation-pavement-inventory-2gx3-zdvfCheckout 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 citydata-mesaaz-gov/transportation-pavement-inventory-2gx3-zdvf:latestThis will download all the objects for the latest tag of citydata-mesaaz-gov/transportation-pavement-inventory-2gx3-zdvf 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 citydata-mesaaz-gov/transportation-pavement-inventory-2gx3-zdvf: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 citydata-mesaaz-gov/transportation-pavement-inventory-2gx3-zdvf: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, citydata-mesaaz-gov/transportation-pavement-inventory-2gx3-zdvf is just another Postgres schema.