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 secured_party_information_in_colorado table in this repository, by referencing it like:
"colorado-gov/secured-party-information-in-colorado-ap62-sav4:latest"."secured_party_information_in_colorado"or in a full query, like:
SELECT
":id", -- Socrata column ID
"zipcode", -- Postal code for address provided for secured party.
"country", -- Country information for secured party.
"organizationname", -- Organization name if this secured party is an organization.
"firstname", -- Individual’s first name.
"lastname", -- Individual’s last name.
"fileid", -- Primary key link between filing, debtor, secured party, and collateral information
"middlename", -- Individual’s middle name.
"address1", -- Line One of secured party’s Address.
"city", -- City in which secured party is located.
"suffix", -- Individual’s name suffix.
"actionrefid", -- Action reference Id contains the sp_id for the secured party that this change or delete affects.
"actiontype", -- Type of action being performed when this secured party is recorded.
"address2", -- Line Two of secured party’s Address.
"spid", -- Unique identifier for Secured Party
"recordstatus", -- Designation of inactive or active. If there was a change made that impacted the record, then the old listing associated becomes inactive. If a listing is 'deleted' from a filing, it is also listed as inactive.
"assignor", -- Indicates if the secured party is an assignor: values: 1-yes; 0-no.
"actiontypecode", -- Type of action being performed when this secured party is recorded (A=add, B=change and delete, C=change only, D=delete only)
"state", -- State in which secured party is located.
"recordstatuscd", -- Designation of inactive or active. If there was a change made that impacted the record, then the old listing associated becomes inactive. If a listing is 'deleted' from a filing, it is also listed as inactive.
"zipcode4" -- If nine digit zip code is given, the full code will be listed here.
FROM
"colorado-gov/secured-party-information-in-colorado-ap62-sav4:latest"."secured_party_information_in_colorado"
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 colorado-gov/secured-party-information-in-colorado-ap62-sav4 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 colorado-gov/secured-party-information-in-colorado-ap62-sav4: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 colorado-gov/secured-party-information-in-colorado-ap62-sav4Checkout 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 colorado-gov/secured-party-information-in-colorado-ap62-sav4:latestThis will download all the objects for the latest tag of colorado-gov/secured-party-information-in-colorado-ap62-sav4 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 colorado-gov/secured-party-information-in-colorado-ap62-sav4: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 colorado-gov/secured-party-information-in-colorado-ap62-sav4: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, colorado-gov/secured-party-information-in-colorado-ap62-sav4 is just another Postgres schema.