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 registration_of_charities_paid_solicitors table in this repository, by referencing it like:
"colorado-gov/registration-of-charities-paid-solicitors-2nui-j9bu:latest"."registration_of_charities_paid_solicitors"or in a full query, like:
SELECT
":id", -- Socrata column ID
"programserviceratio", -- Program service ratio
"expirationdate", -- Date when non profit expires
"dateformed", -- Date when non profit was formed
"placeformed", -- Place where non profit was formed
"principalprovince", -- Province for principal address, if there is one
"principalcountry", -- Country for principal address
"principalsddress2", -- Second line of the principal address
"revenuefromother", -- revenue from other sources
"statusdate", -- Date currentStatus was assigned
"currentstatus", -- Organization registration status with CDOS office
"legalbusinessformation", -- Legal Business Formation
"conflictofinterest", -- Paid Solicitor Conflict of Interest (boolean, null if not a paid solicitor)
"pbcannualbenefitreport", -- For PBC organizations, instructions on obtaining the annual benefit report including location
"pbcbenefitreportsent", -- For PBC organizations, whether benefit annual report was sent to stockholders (y, n, n/a, null if non-pbc)
"pbcrecordingmethod", -- For PBC organizations, recording/accounting method 'accrual', 'cas', or customer input.
"permanentlyrestrictedassets", -- Permanently restricted assets
"temporarilyrestrictedassets", -- Temporarily restricted assets
"unrestrictedassests", -- Unrestricted assets
"endofyearassestsminusliabilities", -- End of year assets minus end of year liabilities
"endofyeartotalliabilities", -- Total end of year liabilities
"endofyearassests", -- Total end of year assets
"expensestotal", -- Total of all expenses
"expensesothercomment", -- Other expenses comment
"expensesother", -- Other expenses
"expensesaffiliates", -- Payment to affiliates expenses
"expensesfundraising", -- Fundraising expenses
"expensesfromadministrativeother", -- Administrative and other general expenses
"expensesfromprogramservices", -- Expenses from program services
"revenuetotal", -- Total of all revenues
"revenuefromsales", -- Revenue from sales
"revenuefromspecialevents", -- Revenue from special events and activities
"programservicerevenue", -- Program service revenue
"revenuefromgovernment", -- Revenue from government
"revenuefromcontibutions", -- Revenue from contributions
"relatedtootherorganization", -- If organization is related to any other organization, then ‘Y’
"relatedorganizations", -- Name of related organization
"totalexpensesplusmanagementgeneraldividedbycontributions", -- (Total fundraising expenses + total management and general expenses) divided by total contributions
"expensesdividedbycontributions", -- Total fundraising expenses divided by total contributions
"totalmanagementgeneralexpensespreviousyear", -- Total management and general expenses in previous year
"totalfundraisingexpensespreviousyear", -- Total fundraising expenses in previous year
"totalcontributionsraisedpreviousyear", -- Total contributions raised in previous year
"outsideprofessionalfundraiserfees", -- Outside professional fundraisers fees
"fiscalyearending", -- Ending tax year this report covers
"fiscalyearbeginning", -- Beginning tax year this report covers
"consolidatedregistrationstatement", -- Is organization’s registration a consolidated Registration statement (‘Y’ or ’N’)
"extensionfiled", -- If extension was filed, then ‘Y’
"irsexemptiondate", -- Date of application for exemption or date of letter of determination of exemption
"taxexemptcode", -- Tax exempt code - IRS subsection
"nteecode3", -- National Taxonomy of Exempt Entities Code Description
"nteecode2", -- National Taxonomy of Exempt Entities Code Description
"nteecode1", -- National Taxonomy of Exempt Entities Code Description
"fiscalyearenddate", -- End of fiscal year
"fiscalyearstartdate", -- Beginning of fiscal year
"nextrenewalregistrationdate", -- Due date for entity’s next renewal of registration
"paymentprocesseddate", -- Date and time payment was processed
"registrationapproveddate", -- Date and time at which registration was approved
"cfosigneddate", -- For Charitable Organizations, date CFO signed registration
"cfoname", -- For Charitable Organizations, CFO first and last name
"authorizedofficername", -- Official first and last name
"website", -- Website URL
"fax", -- Fax number
"phone", -- Phone (area code + 7 digit number + extension)
"mailingprovince", -- Province for the mailing address, if available
"mailingzipcode", -- Mailing zip code
"mailingstate", -- Mailing state
"mailingcity", -- Mailing city
"mailingaddress2", -- Second line of the mailing address
"mailingaddress", -- Mailing address
"residentialcounty", -- Residential county
"principalzipcode", -- Principal zip code
"principalstate", -- Principal state
"principalcity", -- Principal city
"principaladdress", -- Principal address
"actualfinancialsprovided", -- If actual financials are provided then ‘Y’ else ‘N’
"amendmententityid", -- If filing type is Amendment, then Entity ID of master or renewal record
"documentid", -- The number assigned to each document a user files
"filingtype", -- Filing type: Master, Amendment, Renewal, Extension, Fiscal Year Change, Estimate Extension
"fein", -- Federal Employer Identification Number
"name", -- Charitable Organization, Paid Solicitor or Professional Fundraising Consultant name
"registranttypeabbr", -- Registrant Type
"entityid", -- Entity Id
"statedgiftnottaxdeductible", -- If organization state clearly gifts or contributions were not tax deductible, then ‘Y’
"solicitednontaxdeductiblegifts", -- If organization solicited any non-tax deductible gifts or contributions, then ‘Y’
"relatedorganizationtaxexempt", -- If related organization is tax exempt, then ‘Y’
"publicbenefitcorporation", -- If organization is a pbc or not
"pbcpromotedbenefit", -- For PBC organizations, how it promoted benefit information
"mailingcountry", -- Country for the mailing address
"conflictofinterestaffirmation", -- Paid Solicitor Conflict of Interest affirmation (boolean or null if not a paid solicitor)
"revenuefrominvestments", -- Revenue from investments
"taxdeductible", -- If donations to organization are tax deductible, then ‘Y’
"taxexemptstatus", -- If tax exempt organization, then ‘Y’ else ‘N’
"authorizedofficersigneddate"
FROM
"colorado-gov/registration-of-charities-paid-solicitors-2nui-j9bu:latest"."registration_of_charities_paid_solicitors"
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/registration-of-charities-paid-solicitors-2nui-j9bu 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/registration-of-charities-paid-solicitors-2nui-j9bu: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/registration-of-charities-paid-solicitors-2nui-j9buCheckout 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/registration-of-charities-paid-solicitors-2nui-j9bu:latestThis will download all the objects for the latest tag of colorado-gov/registration-of-charities-paid-solicitors-2nui-j9bu 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/registration-of-charities-paid-solicitors-2nui-j9bu: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/registration-of-charities-paid-solicitors-2nui-j9bu: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/registration-of-charities-paid-solicitors-2nui-j9bu is just another Postgres schema.