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 treasury_contracts_multiyear_report table in this repository, by referencing it like:
"oregon-gov/treasury-contracts-multiyear-report-4iz8-xm93:latest"."treasury_contracts_multiyear_report"or in a full query, like:
SELECT
":id", -- Socrata column ID
"supplemental_contract_amount", -- The amount of the amendment or other supplemental contract.
"supplemental_expiration_date", -- The date an amendment or other supplemental contract to the contract expires.
"expiration_date", -- The date the contract expires.
"supplemental_effective_date", -- The date an amendment or other supplemental contract to the contract Is effective and enforceable against the parties. Also known as the Contract Start Date.
"postal_code", -- The postal code assigned by the USPS to the are where the contractor's business is located.
"state_province", -- The state in which the contractor's business is located
"city", -- The city in which the contractor's business is located
"street1", -- The first line of the contractor's business address
"contractor_name", -- The legal name of the vendor awarded the contract
"contract_classification", -- Identifies the classification of goods or services purchased under the contract.
"fiscal_year", -- The fiscal year associated with the transparency contract report, running from July 1 of one year, to June 30 of the following year.
"contract_nte_amount", -- The amount of the contract, including any amount the contract may not exceed, amendments, or other supplemental contract.
"effective_date", -- The date the contract is effective and enforceable against the parties. Also known as the Contract Start Date.
"award_title", -- The title given for each contract entered into Contract Insights, which is Treasury's Contract Management System.
"contract_id" -- An identification number for each contract record that is generated by the Contract Management System.
FROM
"oregon-gov/treasury-contracts-multiyear-report-4iz8-xm93:latest"."treasury_contracts_multiyear_report"
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 oregon-gov/treasury-contracts-multiyear-report-4iz8-xm93 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 oregon-gov/treasury-contracts-multiyear-report-4iz8-xm93: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 oregon-gov/treasury-contracts-multiyear-report-4iz8-xm93Checkout 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 oregon-gov/treasury-contracts-multiyear-report-4iz8-xm93:latestThis will download all the objects for the latest tag of oregon-gov/treasury-contracts-multiyear-report-4iz8-xm93 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 oregon-gov/treasury-contracts-multiyear-report-4iz8-xm93: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 oregon-gov/treasury-contracts-multiyear-report-4iz8-xm93: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, oregon-gov/treasury-contracts-multiyear-report-4iz8-xm93 is just another Postgres schema.