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 uniform_commercial_code_ucc_debtor_information_in table in this repository, by referencing it like:
"colorado-gov/uniform-commercial-code-ucc-debtor-information-in-8upq-58vz:latest"."uniform_commercial_code_ucc_debtor_information_in"or in a full query, like:
SELECT
":id", -- Socrata column ID
"efsuniqueid", -- The unique identifier is a system-generated ID number; only required if the filing is an EFS filing
"zipcode", -- Zip code of trade name debtor and/or organization. Changes from source: If full nine digit zip code is given, this field is shortened to the first five digits.
"country", -- Country of debtor and/or organization.
"city", -- City of debtor and/or organization.
"address2", -- Address of debtor and/or organization.
"address1", -- Address of debtor and/or organization.
"organizationid", -- Id for organization optional.
"organizationtype", -- LLC, Corporation, Partnership, Nonprofit, Government Entity are common categories among over 3,000 unique entries in this field.
"organizationjurisdiction", -- State or other region of the organization.
"organizationname", -- Estate, trust, farm or other administrative group.
"middlename", -- Middle name of debtor.
"firstname", -- First name of debtor.
"fileid", -- Primary key link between filing, debtor, secured party, and collateral information. The state assigned identification number (unique) for the collateral entity.
"debtorid", -- The state assigned identification number (unique) for the debtor. Changes from source: Removed new lines from source file.
"actiontype", -- Full description of type of action being performed when this debtor is recorded (A=add, B=change and delete, C=change only, D=delete only)
"zipcode4", -- Zip code plus 4 of trade name debtor and/or organization. Changes from source: If full nine digit zip code is given, this field is shortened to the last four digits.
"suffix", -- suffix
"state", -- State of debtor and/or organization.
"lastname", -- Last name of debtor.
"debtordescription", -- Description of the debtor's relationship to debt holder or other administrator. Collateral is being administered by a Decedent's Personal Representative or is held in a Trust or the debtor is: a decendent's estate, is a transmitting utility, a trust, is a trustee acting with respect to property held in a trust.
"actionreferenceid", -- The coll_id for the collateral item related to the record.
"actiontypecode", -- Type of action being performed when this collateral is recorded (A=add, B=change and delete, C=change only, D=delete only)
"recordstatuscode", -- Designated codifier for 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.
"recordstatus" -- Inactive or active designation, full description. 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.
FROM
"colorado-gov/uniform-commercial-code-ucc-debtor-information-in-8upq-58vz:latest"."uniform_commercial_code_ucc_debtor_information_in"
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/uniform-commercial-code-ucc-debtor-information-in-8upq-58vz 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/uniform-commercial-code-ucc-debtor-information-in-8upq-58vz: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/uniform-commercial-code-ucc-debtor-information-in-8upq-58vzCheckout 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/uniform-commercial-code-ucc-debtor-information-in-8upq-58vz:latestThis will download all the objects for the latest tag of colorado-gov/uniform-commercial-code-ucc-debtor-information-in-8upq-58vz 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/uniform-commercial-code-ucc-debtor-information-in-8upq-58vz: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/uniform-commercial-code-ucc-debtor-information-in-8upq-58vz: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/uniform-commercial-code-ucc-debtor-information-in-8upq-58vz is just another Postgres schema.