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 local_law_44_development_team table in this repository, by referencing it like:
"cityofnewyork-us/local-law-44-development-team-6anw-twe4:latest"."local_law_44_development_team"or in a full query, like:
SELECT
":id", -- Socrata column ID
"individualtitle", -- Development Team Individual's actual title
"entityname", -- The name of an entity associated with a project
"entityindividualindicator", -- Notes whether the Development Team owner or officer is an Entity or an Individual
"individualrole", -- Notes whether a Development Team Individual is a "Principal Officer" or "Principal Owner" or both.
"individualofficerequivalence", -- The Officer equivalence for a Development Team Individual who serves as or performs the functions of Chief Executive Officer (CEO), Chief Finance Officer (CFO), or Chief Operating Officer (COO)
"housenumber", -- Primary House Number is the building or house number for Development Team Entity or Individual's address
"longitude", -- The longitude associated with the provided entity location.
"borough", -- The name associated with the borough in which the entity is located
"census_tract", -- The US census tract associated with the provided entity location
"type", -- Notes whether an Entity or an Individual is the Borrower Legal Entity, General Contractor and/or Subcontractor
"careof", -- "Care of" (C/O) for Development Team Entity or Individual's address
"bin", -- The Building Identification Number (BIN) associated with the provided entity location.
"developmentteamdwid", -- Unique identifier of Development team in data warehouse
"projectid", -- The unique ID that refers back to the Project ID column in the Project table (Foreign Key to the Project table)
"firstname", -- First name of a "Principal Officer" or "Principal Owner" for an Individual associated with a Borrower Legal Entity, General Contractor, or Subcontractor on the project
"lastname", -- Last name of a "Principal Officer" or "Principal Owner" for an Individual associated with a Borrower Legal Entity, General Contractor, or Subcontractor on the project
"parententityname", -- Name of parent entity associated with the Development Team Entity or Individual
"streetname", -- Street name for Development Team Entity or Individual's address
"apartmentsuitefloor", -- Apartment, suite or floor number for Development Team Entity or Individual's address
"city", -- City for Development Team Entity or Individual's address
"state", -- State (abbreviation) for Development Team Entity or Individual's address
"zip", -- ZIP Code for Development Team Entity or Individual's address
"tradetype", -- Subcontractor's trade as a category
"latitude", -- The latitude associated with the provided entity location.
"community_board", -- The NYC community board associated with the provided entity location
"council_district", -- The NYC council district associated with the provided entity location
"bbl", -- The Borough, Block, Lot (BBL) associated with the provided entity location.
"nta" -- The Neighborhood Tabulation Area (NTA) associated with the provided entity location
FROM
"cityofnewyork-us/local-law-44-development-team-6anw-twe4:latest"."local_law_44_development_team"
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/local-law-44-development-team-6anw-twe4 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/local-law-44-development-team-6anw-twe4: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/local-law-44-development-team-6anw-twe4Checkout 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/local-law-44-development-team-6anw-twe4:latestThis will download all the objects for the latest tag of cityofnewyork-us/local-law-44-development-team-6anw-twe4 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/local-law-44-development-team-6anw-twe4: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/local-law-44-development-team-6anw-twe4: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/local-law-44-development-team-6anw-twe4 is just another Postgres schema.