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 paid_solicitor_solicitation_notices_in_colorado table in this repository, by referencing it like:
"colorado-gov/paid-solicitor-solicitation-notices-in-colorado-ew9y-6tv9:latest"."paid_solicitor_solicitation_notices_in_colorado"or in a full query, like:
SELECT
":id", -- Socrata column ID
"accountingrecordszipcode", -- Zip where accounting records are kept
"accountingrecordsstate", -- State where accounting records are kept
"accountingrecordscity", -- City where accounting records are kept
"contractsigner4organization", -- Organization of signer number 4
"contractsigner4title", -- Title of signer number 4
"contractsigner4lastname", -- Last name of signer number 4
"contractsigner3organization", -- Organization of signer number 3
"contractsigner3title", -- Title of signer number 3
"contractsigner2organization", -- Organization of signer number 2
"contractsigner2title", -- Title of signer number 2
"contractsigner2lastname", -- Last name of signer number 1
"contractsigner2firstname", -- First name of signer number 1
"contractsigner1organization", -- Organization of signer number 1
"contractsigner1title", -- Title of signer number 1
"contractsigner1lastname", -- Last name of signer number 1
"contractsigner1firstname", -- First name of signer number 1
"solicitorcompensationassumptions", -- Assumptions upon which estimate of solicitors compensation is based
"respectiveobligations", -- Respective obligations of Paid Solicitor and Charitable Organization
"percentagegrossrevenuepaidsolicitorcompensation", -- Percentage of gross revenue constituting Paid Solicitor's compensation
"specifiedpercentagegrossrevenuereceivedbysolicitor", -- Specified percentage of gross revenue received by Paid Solicitor
"minimumpercentagesaleremitted", -- Minimum percentage of sale remitted to Charitable Organization
"percentageeventpriceremitted", -- Will percentage of purchase price to event be remitted to the charitable organization?
"minimumpercentageofgrossreceiptsremitted", -- Minimum percentage of gross receipts remitted to charitable organization
"contractterminationdate", -- Termination date of the contract
"contracteffectivedate", -- Effective date of the contract
"eventcampaigndescription", -- Description of any event the campaign will lead up to
"custodyofcontributions", -- Will Paid Solicitor ever have custody of contributions?
"charitysigneddate", -- Date Charitable Organization Official signed campaign report
"charityofficername", -- Charitable Organization Official first and last name
"campaignconclusiondate", -- Conclusion date of campaign
"campaigncommencementdate", -- Commencement date of campaign
"paymentprocesseddate", -- Date and time payment was processed
"solicitationapproveddate", -- Date and time at which solicitation notice was approved
"amendmententityid", -- If filing type is Amendment, then Entity ID of master or renewal record
"documentid", -- Accounting ID (Solicitation Notice Identification Number)
"paidsolicitorentityid", -- Paid Solicitor Entity ID
"entityid", -- Charitable Organization Entity ID
"charityname", -- Charitable Organization Name
"solicitationnoticeid", -- Solicitation Notice ID
"contractsigner3lastname", -- Last name of signer number 3
"contractsigner3firstname", -- First name of signer number 3
"snid", -- Internal Record Number
"accountingrecordsaddress", -- Address where accounting records are kept
"contractsigner4firstname", -- First name of signer number 4
"solicitorname", -- Paid Solicitor Name
"paidsolicitorscompensatedcontingetoncontributions", -- Is Paid Solicitor's compensation contingent upon number of contributions or amount received
"custodyoffinancialrecords", -- Will Paid Solicitor ever have custody of financial records of contributions?
"fileingstatus", -- Filing Status
"percentagebasedcontract", -- Will specified percentage of gross receipts be remitted to charitable organization?
"administeringwithdrawingcontrol", -- Does Charitable Organization control administering and withdrawing from the account
"filingtype" -- Filing type: Master, Amendment, Renewal
FROM
"colorado-gov/paid-solicitor-solicitation-notices-in-colorado-ew9y-6tv9:latest"."paid_solicitor_solicitation_notices_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/paid-solicitor-solicitation-notices-in-colorado-ew9y-6tv9 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/paid-solicitor-solicitation-notices-in-colorado-ew9y-6tv9: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/paid-solicitor-solicitation-notices-in-colorado-ew9y-6tv9Checkout 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/paid-solicitor-solicitation-notices-in-colorado-ew9y-6tv9:latestThis will download all the objects for the latest tag of colorado-gov/paid-solicitor-solicitation-notices-in-colorado-ew9y-6tv9 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/paid-solicitor-solicitation-notices-in-colorado-ew9y-6tv9: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/paid-solicitor-solicitation-notices-in-colorado-ew9y-6tv9: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/paid-solicitor-solicitation-notices-in-colorado-ew9y-6tv9 is just another Postgres schema.