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 nys_attorney_registrations table in this repository, by referencing it like:
"ny-gov/nys-attorney-registrations-eqw2-r5nb:latest"."nys_attorney_registrations"or in a full query, like:
SELECT
":id", -- Socrata column ID
"county", -- The New York county of the office address; “Out of State” if office address is not in NYS
"phone_number", -- The attorney's business telephone number; blank if no phone number is recorded
"status", -- The registration status of the attorney; valid values are: • Delinquent; • Deceased; • Incapacitated; • Resigned; • Resigned from bar - disciplinary reason; • Disbarred; • Due to Register; • Currently registered; • Due to reregister within 30 days of birthday; • Suspended.
"company_name", -- The attorney’s office name
"street_1", -- Street address line 1 of the office address
"zip_plus_four", -- The zip plus four of the office address; blank if no Zip Plus Four is recorded
"country", -- The country of the office address
"zip", -- The 5-digit zip code of the office address
"city", -- The city of the office address
"street_2", -- Street address line 2 of the office address; blank if no street address line 2 is recorded
"state", -- The state of the office address
"first_name", -- The attorney’s first name
"judicial_department_of_admission", -- The judicial department of admission to the NY Bar
"registration_number", -- 7-digit number unique to each attorney
"next_registration", -- The month and year when the attorney's next biennial registration is due
"year_admitted", -- The year the attorney was admitted to the NY Bar
"suffix", -- The attorney’s name suffix; blank if no suffix is recorded
"law_school", -- The law school from which degree was granted
"middle_name", -- The attorney’s middle name; blank if no middle name is recorded
"last_name" -- The attorney’s last name
FROM
"ny-gov/nys-attorney-registrations-eqw2-r5nb:latest"."nys_attorney_registrations"
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 ny-gov/nys-attorney-registrations-eqw2-r5nb 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 ny-gov/nys-attorney-registrations-eqw2-r5nb: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 ny-gov/nys-attorney-registrations-eqw2-r5nbCheckout 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 ny-gov/nys-attorney-registrations-eqw2-r5nb:latestThis will download all the objects for the latest tag of ny-gov/nys-attorney-registrations-eqw2-r5nb 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 ny-gov/nys-attorney-registrations-eqw2-r5nb: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 ny-gov/nys-attorney-registrations-eqw2-r5nb: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, ny-gov/nys-attorney-registrations-eqw2-r5nb is just another Postgres schema.