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 expenses_of_charities_operating_in_colorado table in this repository, by referencing it like:
"colorado-gov/expenses-of-charities-operating-in-colorado-x2jf-bvk8:latest"."expenses_of_charities_operating_in_colorado"or in a full query, like:
SELECT
":id", -- Socrata column ID
"id", -- Automatically generated unique ID
"taxyr", -- Tax year corresponding to the charitable organization's filing
"businessname1", -- Name of the charitable organization
"businessname2", -- Additional name of the charitable organization if applicable
"ein", -- Employer identification number for charitable organization
"pygrantsandsimilarpaidamt", -- Grants and similar amounts paid from prior year
"cygrantsandsimilarpaidamt", -- Grants and similar amounts paid from current year
"pybenefitspaidtomembersamt", -- Benefits paid to or for members from prior year
"cybenefitspaidtomembersamt", -- Benefits paid to or for members from current year
"pysalariescompempbnftpaidamt", -- Salaries, other compensation, employee benefits from prior year
"cysalariescompempbnftpaidamt", -- Salaries, other compensation, employee benefits from current year
"pytotalproffndrsngexpnsamt", -- Grants and other assistance to domestic organizations and domestic governments from prior year
"cytotalproffndrsngexpnsamt", -- Grants and other assistance to domestic organizations and domestic governments from current year
"cytotalfundraisingexpenseamt", -- Total fundraising expenses from current year
"pyotherexpensesamt", -- Other expenses from prior year
"cyotherexpensesamt", -- Other expenses from current year
"pytotalexpensesamt", -- Total expenses from prior year
"cytotalexpensesamt", -- Total expenses from current year
"pyrevenueslessexpensesamt", -- Revenue less expenses from prior year
"cyrevenueslessexpensesamt", -- Revenue less expenses from current year
"professionalfundraisingind", -- Indicator for if the organization reported a total of more than $15,000 of expenses for professional fundraising services
"compensationprocessceoind", -- Indicator for if there is a compensation process for the organization’s CEO, Executive Director, or top management official
"compensationprocessotherind", -- Indicator for if there is a compensation process for other officers or key employees of the organization
"indivrcvdgreaterthan100kcnt", -- Total number of individuals (including but not limited to those listed above) who received more than $100,000 of reportable compensation from the organization
"cntrctrcvdgreaterthan100kcnt", -- Total number of independent contractors (including but not limited to those listed above) who received more than $100,000 of compensation from the organization
"grantstodomesticorgsgrp_totalamt", -- Total amount for grants and other assistance to domestic organizations
"grantstodomesticorgsgrp_programservicesamt", -- Program service amount for grants and other assistance to domestic organizations
"grantstodomesticindividualsgrp_totalamt", -- Total amount for grants and other assistance to domestic individuals
"grantstodomesticindividualsgrp_programservicesamt", -- Program service amount for grants and other assistance to domestic individuals
"foreigngrantsgrp_totalamt", -- Total amount for grants and other assistance to foreign organizations, foreign governments, and foreign individuals
"foreigngrantsgrp_programservicesamt", -- Program service amount for grants and other assistance to foreign organizations, foreign governments, and foreign individuals
"compcurrentofcrdirectorsgrp_totalamt", -- Compensation of current officers, directors, trustees, and key employees total amount
"compcurrentofcrdirectorsgrp_programservicesamt", -- Compensation of current officers, directors, trustees, and key employees program services amount
"compcurrentofcrdirectorsgrp_managementandgeneralamt", -- Compensation of current officers, directors, trustees, and key employees management and general amount
"compcurrentofcrdirectorsgrp_fundraisingamt", -- Compensation of current officers, directors, trustees, and key employees fundraising amount
"totalfunctionalexpensesgrp_totalamt", -- Total functional expenses total amount
"totalfunctionalexpensesgrp_programservicesamt", -- Total functional expenses program services amount
"totalfunctionalexpensesgrp_managementandgeneralamt", -- Total functional expenses management and general amount
"totalfunctionalexpensesgrp_fundraisingamt", -- Total functional expenses fundraising amount
"jointcostsind", -- Indicator for if the organization has joint costs
"totaljointcostsgrp_fundraisingamt", -- Total joint costs fundraising amount
"totaljointcostsgrp_managementandgeneralamt", -- Total joint costs management and general amount
"totaljointcostsgrp_programservicesamt", -- Total joint costs program services amount
"totaljointcostsgrp_totalamt" -- Total joint costs total amount
FROM
"colorado-gov/expenses-of-charities-operating-in-colorado-x2jf-bvk8:latest"."expenses_of_charities_operating_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/expenses-of-charities-operating-in-colorado-x2jf-bvk8 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/expenses-of-charities-operating-in-colorado-x2jf-bvk8: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/expenses-of-charities-operating-in-colorado-x2jf-bvk8Checkout 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/expenses-of-charities-operating-in-colorado-x2jf-bvk8:latestThis will download all the objects for the latest tag of colorado-gov/expenses-of-charities-operating-in-colorado-x2jf-bvk8 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/expenses-of-charities-operating-in-colorado-x2jf-bvk8: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/expenses-of-charities-operating-in-colorado-x2jf-bvk8: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/expenses-of-charities-operating-in-colorado-x2jf-bvk8 is just another Postgres schema.