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 dob_cellular_antenna_filings table in this repository, by referencing it like:
"cityofnewyork-us/dob-cellular-antenna-filings-iz2q-9x8d:latest"."dob_cellular_antenna_filings"or in a full query, like:
SELECT
":id", -- Socrata column ID
"street_name", -- Street Name where Property is located
"dobrundate", -- Date when query is run and pushed to Open Data. Could be used to differentiate report dates.
"job_description", -- Job Description
"first_permit_date", -- Date of first issuance of permit
"owner_s__phone__", -- Owner's Phone #
"zip_code", -- Zip Code
"state", -- State
"city", -- City
"owner_s__house_street", -- House Street of Property Owner
"owner_s__house__", -- House # of Property Owner
"owner_s_business_name", -- Business Name of Property Owner
"owner_s_last_name", -- Last Name of property owner
"owner_s_first_name", -- First Name of property owner
"non_profit", -- Non-Profit
"owner_type_description", -- Owner Type Description
"owner_type", -- Owner Type
"special_distr_2_", -- Special Distr 2
"special_distr_1", -- Special Distr 1
"zoning_distr_3", -- Zoning Distr 3
"zoning_distr_2", -- Zoning Distr 2
"zoning_distr_1", -- Zoning Distr 1
"proposed_occupancy", -- Proposed Occupancy
"existing_occupancy", -- Existing Occupancy
"fee_status", -- Type of Fee
"total_est_fee", -- Estimated fee of job
"initial_cost", -- Estimated cost of job
"fully_permitted", -- Date when job is fully permitted
"approved", -- Date when job is approved
"assigned", -- Date when job is assigned to plan examiner
"fully_paid", -- Date when job is paid and entered
"paid", -- Date when job is paid
"pre_filing_date", -- Date when job is prefiled
"professional_cert", -- Job is Professionally Certified by Licensed Professional instead of having it reviewed by Department of Building's Plan Examiners
"applicant_license__", -- Number assigned to the skilled trade person/contractor or licensed professional
"applicant_professional_title", -- Applicant's Professional Title
"applicant_s_last_name", -- Last Name of Applicant
"applicant_s_first_name", -- First Name of Applicant
"landmarked", -- L code indicates that the building has been assigned landmark status
"community___board", -- 3-digit identifier: Borough code = first position, last 2 = community board
"building_type", -- 1-2-3 Family or Other
"latest_action_date", -- Latest status date
"job_status_descrp", -- Status code description
"job_status", -- DOB Status code of job (A-Pre Filed, I-Sign Off, P- Approved, R-Permit Entire) Complete List - http://www.nyc.gov/html/dob/downloads/pdf/bisjobstatus.pdf
"job_type", -- Job Type, based on DOB Job Code (NB-New Building, A1, A2, A3- Alterations 1-3, SG-Sign, etc.)
"bin__", -- Number assigned by City Planning to a specific building
"lot", -- Tax lot assigned by Department of Finance
"block", -- Tax block assigned by Department of Finance
"house__", -- House Number of Residence or Commercial Property
"borough", -- 1= Manhattan, 2= Bronx, 3 = Brooklyn, 4 = Queens, 5 = Staten Island
"doc__", -- Document Number
"job__", -- Number assigned by DOB to Job Filing
"other_description", -- Other Description
"other", -- Other (X=Yes, Blank=No)
"pc_filed", -- Application Filed electronically, rather than manually
"little_e" -- Hazardous
FROM
"cityofnewyork-us/dob-cellular-antenna-filings-iz2q-9x8d:latest"."dob_cellular_antenna_filings"
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/dob-cellular-antenna-filings-iz2q-9x8d with SQL in under 60 seconds.
This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.cityofnewyork.us. When you querycityofnewyork-us/dob-cellular-antenna-filings-iz2q-9x8d: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; sgrcan 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 cloneand sgr checkout.
Mounting Data
This repository is an external repository. It's not hosted by Splitgraph. It is hosted by data.cityofnewyork.us, 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 \
"cityofnewyork-us/dob-cellular-antenna-filings-iz2q-9x8d" \
--handler-options '{
"domain": "data.cityofnewyork.us",
"tables": {
"dob_cellular_antenna_filings": "iz2q-9x8d"
}
}'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, cityofnewyork-us/dob-cellular-antenna-filings-iz2q-9x8d is just another Postgres schema.