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 historic_districts table in this repository, by referencing it like:
"cityofnewyork-us/historic-districts-skyk-mpzq:latest"."historic_districts"or in a full query, like:
SELECT
":id", -- Socrata column ID
"area_name", -- Name of the calendared, heard, or designated historic district or study area
"public_hea", -- Date of public hearing(s); Note: It is possible for one item to have multiple public hearing dates; this field will be blank for items which have not yet had a public hearing
"last_actio", -- Last action taken as part of the LP number (i.e. the LP action), specific to the BBL; Note: The last action on a specific BBL may differ from the greater action on the LP number if, for example, an item was left out of the boundaries of a larger historic district. NOTE: To determine the present status of any boundary in the shapefile, the fields "CURRENT_", "STATUS_OF_BOUNDARY", "LAST_ACTION_ON_LP", and "BOUNDARY_NOTE" must be looked at collectively. For example, a designated records will appear as "CURRENT"=Yes, "STATUS_OF_BOUNDARY"="DESIGNATED", "LAST_ACTION_ON_LP"= "DESIGNATED".
"boundary_n", -- Text field providing clarification for the LAST_ACTION_ON_BOUNDARY field
"desdate", -- Date of designation; Note: This field will be blank for items not designated
"extension", -- Denotes (either yes or no) whether the item is an extension of a previously designated historic district
"the_geom", -- Geometry column
"borough", -- Borough expressed as a two character abbreviation (MN=Manhattan, BX=Bronx, BK=Brooklyn, QN=Queens, and SI=Staten Island)
"current_", -- Indicates whether a record in the database is presently active/current (No=Not active/current; Yes=Active/current)
"shape_leng",
"lp_number", -- Internal LPC identifier (LP-XXXXX) used to identify a single designation (one LP number is assigned per Historic District, Individual, Scenic, or Interior Landmark)
"shape_area",
"caldate", -- Date of calendaring; Note: Not all items have a date of calendaring (date of calendaring was not tracked until the 1990s)
"other_hear", -- Notes other relevant public hearing dates for the item (that are known at this time; not comprehensive)
"status_of_" -- Present designation status of the boundary as drawn (which may differ from the final action taken for the district); NOTE: To determine the present status of any boundary in the shapefile, the fields "CURRENT_", "STATUS_OF_BOUNDARY", "LAST_ACTION_ON_LP", and "BOUNDARY_NOTE" must be looked at collectively. For example, a designated records will appear as "CURRENT"=Yes, "STATUS_OF_BOUNDARY"="DESIGNATED", "LAST_ACTION_ON_LP"= "DESIGNATED".
FROM
"cityofnewyork-us/historic-districts-skyk-mpzq:latest"."historic_districts"
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/historic-districts-skyk-mpzq 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/historic-districts-skyk-mpzq: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/historic-districts-skyk-mpzqCheckout 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/historic-districts-skyk-mpzq:latestThis will download all the objects for the latest tag of cityofnewyork-us/historic-districts-skyk-mpzq 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/historic-districts-skyk-mpzq: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/historic-districts-skyk-mpzq: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/historic-districts-skyk-mpzq is just another Postgres schema.