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 tlc_new_driver_application_status
table in this repository, by referencing it like:
"cityofnewyork-us/tlc-new-driver-application-status-dpec-ucu7:latest"."tlc_new_driver_application_status"
or in a full query, like:
SELECT
":id", -- Socrata column ID
"driver_exam", -- Upon Completion of TLC Driver Training (Taxi School), you will need to take and pass a final exam. Passing score is 70%. “Needed”: Your TLC Driver Exam information is not in our system. If you have not taken your TLC Driver Exam please do so. “Not Applicable”: If you applied for a Paratransit or Commuter Van license you will not need to take this exam. “Complete”: Your TLC Driver Exam information has been received and updated in your TLC record
"app_date", -- The date you submitted your application.
"wav_course", -- Wheelchair Accessible Vehicle Training (WAV) is a requirement for those who apply for a Medallion or For-Hire Vehicle driver’s license. “Needed”: You must take the Wheelchair Accessible Vehicle Training Course within 90 days from the date you submitted your application. “Not Applicable”: If you applied for a Paratransit or Commuter Van license you will not need to take this training. “Complete”: Your WAV training information has been received and updated in your TLC record.
"fru_interview_scheduled", -- Fitness Review Unit Interview: “Not Applicable” if no Fitness Review is necessary. OR If there is a date, a Fitness Interview has been scheduled. Watch your mail/email for more information.
"drug_test", -- Drug testing is required for Medallion and FHV TLC driver’s licenses. "Needed": You must take and pass a drug test at an approved testing facility. “Not Applicable”: If you applied for a Paratransit or Commuter Van license you do not need to take a TLC Drug Test. “Complete”: Your drug test information has been received and updated in your TLC record.
"type", -- This is the classification of license you have applied for. HDR: Medallion /For-Hire Vehicle Operator. PDR: Paratransit Vehicle Operator. VDR: Commuter Van Vehicle Operator
"app_no", -- This is the number linked to your application. Once your application has been approved this will become your license number.
"other_requirements", -- This field is for miscellaneous items that may need more sensitive information. Visit www.nyc.gov/tlcup for more information and to upload missing requirements. “Not Applicable”: “Other requirements” do not apply to you at this time.
"defensive_driving", -- A NYS certified 6 hour Defensive Driving Course is a requirement to receive your TLC license.
"medical_clearance_form", -- A Medical Clearance form from a licensed medical doctor is a requirement for those who apply for a Medallion or a For-Hire Vehicle driver’s license. If the entry is: “Needed”: Your Medical Clearance form is not in our system. If you have not been medically cleared by a licensed medical doctor please do so immediately. “Not Applicable”: If you applied for a Paratransit or Commuter Van license you will not need to take this step as it is covered by your 19A status. “Complete”: Your Medical Clearance has been received and updated in your TLC record.
"lastupdate", -- Latest Updated Date
"status" -- "Incomplete": Your application is missing requirements. "Pending Fitness Interview": Your application has been forwarded to the Fitness Review Unit for a Fitness Interview. "Denied": Your application has been denied. "Under Review": Your application is still being processed. "Approved - License Issued": Your application has been approved and your license will be mailed to the address provided on your application. Allow up to two weeks after approval for delivery.
FROM
"cityofnewyork-us/tlc-new-driver-application-status-dpec-ucu7:latest"."tlc_new_driver_application_status"
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/tlc-new-driver-application-status-dpec-ucu7
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; sgr
can 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 clone
and sgr checkout
.
Cloning Data
Because cityofnewyork-us/tlc-new-driver-application-status-dpec-ucu7: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/tlc-new-driver-application-status-dpec-ucu7
Checkout 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/tlc-new-driver-application-status-dpec-ucu7:latest
This will download all the objects for the latest
tag of cityofnewyork-us/tlc-new-driver-application-status-dpec-ucu7
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/tlc-new-driver-application-status-dpec-ucu7: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/tlc-new-driver-application-status-dpec-ucu7:latest
This 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/tlc-new-driver-application-status-dpec-ucu7
is just another Postgres schema.