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 capital_planning_proposal_lines_gold_copy table in this repository, by referencing it like:
"budget-qa-reporting-data-socrata/capital-planning-proposal-lines-gold-copy-ue9x-hnvs:latest"."capital_planning_proposal_lines_gold_copy"or in a full query, like:
SELECT
":id", -- Socrata column ID
"functionheader", -- Function Header
"usersegment4header", -- User Segment4 Header
"usersegment1segment", -- User Segment1 Value
"unitname", -- Unit Name
"phasename", -- Phase Name
"locationname", -- Location Name
"grantsegment", -- Grant
"gradename", -- Grade Name
"fundingsourceheader", -- Funding Source Header
"fundingsourcename", -- Funding Source Name
"fundingsourcesegment", -- Funding Source
"divisionname", -- Division Name
"classsegment", -- Class Value
"activitysegment", -- Activity
"projectedfundingamount", -- Projected Funding Source Amount
"costamount", -- Cost Amount
"accounttype", -- Account Type (Cost, Funding Source, Projection)
"accountdescription", -- Account Descriptions
"iscurrentproposal", -- Most Current Stage
"proposalname", -- Proposal Name
"stageduedate", -- Date that the current Stage for this item is due to be completed
"stageseqorder", -- Stage Order
"stagename", -- Stage Name
"projectstrategicgoal", -- Strategic Goal
"proposalscore", -- Proposal Score
"projectpriority", -- Project Priority
"projectstatus", -- Project Status (New, Adopted, Canceled, Complete)
"projecttype", -- Project Type
"projectcoordinates", -- Project Coordinates
"projectlocation", -- Location Description
"projectexternalcode", -- Exterior Project Code
"capitalprojectname", -- Project Name
"period", -- GL Period
"projectid", -- Project ID
"entityname", -- Entity
"categoryname", -- Category Name
"usersegment5name", -- User Segment5 Name
"usersegment4name", -- User Segment4 Name
"usersegment3name", -- User Segment3 Name
"usersegment2name", -- User Segment2 Name
"usersegment1name", -- User Segment1 Name
"taskname", -- Task Name
"subfundname", -- Subfund Name
"proposaldocumentlink", -- Hyper Link to Proposal
"projectheader", -- Project Header
"programname", -- Program Name
"organizationname", -- Organization Name
"objectname", -- Object Name
"grantname", -- Grant Name
"fundname", -- Fund Name
"fundingtypename", -- Funding Type Name
"functionsegment", -- Function Value
"functionname", -- Function Name
"entitysegment", -- Entity Value
"entityheader", -- Entity Header
"departmentsegment", -- Department Value
"departmentname", -- Department Name
"departmentheader", -- Department Header
"costcentersegment", -- Cost Center Value
"costcentername", -- Cost Center Name
"classname", -- Class Name
"categoryheader", -- Category Header
"captialplanname", -- Capital Plan
"agencyname", -- Agency Name
"activityname", -- Activity Name
"usersegment5header", -- User Segment5 Header
"usersegment5segment", -- User Segment5 Value
"usersegment4segment", -- User Segment4 Value
"usersegment3header", -- User Segment3 Header
"usersegment3segment", -- User Segment3 Value
"usersegment2header", -- User Segment2 Header
"usersegment2segment", -- User Segment2 Value
"usersegment1header", -- User Segment1 Header
"unitheader", -- Unit Header
"unitsegment", -- Unit
"taskheader", -- Task Header
"tasksegment", -- Task
"subfundheader", -- Subfund Heade
"subfundsegment", -- Subfund
"projectname", -- Project Name
"projectsegment", -- Project
"programheader", -- Program Header
"programsegment", -- Program
"phaseheader", -- Phase Header
"phasesegment", -- Phase
"organizationheader", -- Organization Header
"organizationsegment", -- Organization
"objectheader", -- Object Header
"objectsegment", -- Object
"locationheader", -- Location Header
"locationsegment", -- Location
"grantheader", -- Grant Header
"gradeheader", -- Grader Header
"gradesegment", -- Grade
"fundingtypeheader", -- Funding Type Header
"fundingtypesegment", -- Funding Type
"fundheader", -- Fund Header
"fundsegment", -- Fund Value
"divisionheader", -- Division Header
"divisionsegment", -- Division Value
"costcenterheader", -- Cost Center Header
"classheader", -- Class Header
"categorysegment", -- Category Value
"agencyheader", -- Agency Header
"agencysegment", -- Agency
"activityheader", -- Activity Header
"projectdocumentlink", -- Hyper Line to Project
"fundingsourceamount", -- Funding Source Amount
"lineaccount", -- Account
"isincluded", -- Included
"projectmanager", -- Project Manager
"projectdepartment", -- Project Department
"projectedenddate", -- Projected End Date
"projectedstartdate" -- Projected Start Date
FROM
"budget-qa-reporting-data-socrata/capital-planning-proposal-lines-gold-copy-ue9x-hnvs:latest"."capital_planning_proposal_lines_gold_copy"
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 budget-qa-reporting-data-socrata/capital-planning-proposal-lines-gold-copy-ue9x-hnvs 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 budget-qa-reporting-data-socrata/capital-planning-proposal-lines-gold-copy-ue9x-hnvs: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 budget-qa-reporting-data-socrata/capital-planning-proposal-lines-gold-copy-ue9x-hnvsCheckout 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 budget-qa-reporting-data-socrata/capital-planning-proposal-lines-gold-copy-ue9x-hnvs:latestThis will download all the objects for the latest tag of budget-qa-reporting-data-socrata/capital-planning-proposal-lines-gold-copy-ue9x-hnvs 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 budget-qa-reporting-data-socrata/capital-planning-proposal-lines-gold-copy-ue9x-hnvs: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 budget-qa-reporting-data-socrata/capital-planning-proposal-lines-gold-copy-ue9x-hnvs: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, budget-qa-reporting-data-socrata/capital-planning-proposal-lines-gold-copy-ue9x-hnvs is just another Postgres schema.