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 yourmoney_retired_pension_members table in this repository, by referencing it like:
"nj-gov/yourmoney-retired-pension-members-nma7-ti96:latest"."yourmoney_retired_pension_members"or in a full query, like:
SELECT
":id", -- Socrata column ID
"mthly_total_allowances", -- The total amount of the monthly benefit (sum of prior three fields).
"last_standard_allowance_yearmo", -- Last year and month of benefits paid. Format is CCYY/MM.
"ytd_pension_pymnts", -- The year-to-date pension benefits paid.
"report_year_month", -- Four digit year representing the twelve month period starting with January and ending with December. Indicates the calendar year in which payments were actually made to the pensioner. Calendar year and calendar month together represent the end of the reporting period.
"retirement_cancellation_date", -- The date retirement was cancelled. Format is MM/DD/CCYY.
"last_disbursement_yearmo", -- The last year and month of benefits paid. Format is CCYY/MM.
"ytd_one_time_adjustment_pymnts", -- The year-to-date amount of the onetime adjustments.
"member_pension_fund", -- Pension fund from which the benefits are drawn.
"member_final_months_of_service", -- The total months of service for the member.
"member_last_employer", -- Last employer (location) where pension was earned for the listed pension fund.
"member_full_name", -- Full name (Last, First Middle Initial) of the member at the end of the reporting period.
"member_frst_name", -- The first name of the member at the end of the reporting period.
"ytd_total_paymnts", -- The year-to-date total amount of benefits received.
"as_of_date", -- The last day of the quarter of data represented in this dataset.
"mthly_pension_allowance", -- The amount of the monthly benefit.
"member_middle_initial", -- The middle initial of the member at the end of the reporting period.
"member_last_name", -- The last name of the member at the end of the reporting period.
"member_salary_for_calculation", -- Salary utilized for pension benefit calculations.
"member_key", -- A value that uniquely identifies members receiving pension benefits. When benefits are being paid from more than one pension fund on behalf of any given member, all records for that member will contain the same value in this key.
"member_retirement_date", -- The retirement year and month. Format is CCYY/MM.
"ytd_supplemental_pymnts", -- The year-to-date amount of the monthly supplemental allowance.
"mthly_cost_of_living_allowance", -- The amount of the monthly cost of living allowance.
"mthly_supplemental_allowance", -- The amount of the monthly supplemental allowance.
"member_retirement_cause", -- The type of retirement for the member (e.g. Service, Early, Disability).
"type_of_benefit", -- Indicates who is receiving the benefits - “Member” or “Survivor”
"ytd_cost_of_living_pymnts" -- The year-to-date amount of the monthly cost of living allowance.
FROM
"nj-gov/yourmoney-retired-pension-members-nma7-ti96:latest"."yourmoney_retired_pension_members"
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 nj-gov/yourmoney-retired-pension-members-nma7-ti96 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 nj-gov/yourmoney-retired-pension-members-nma7-ti96: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 nj-gov/yourmoney-retired-pension-members-nma7-ti96Checkout 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 nj-gov/yourmoney-retired-pension-members-nma7-ti96:latestThis will download all the objects for the latest tag of nj-gov/yourmoney-retired-pension-members-nma7-ti96 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 nj-gov/yourmoney-retired-pension-members-nma7-ti96: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 nj-gov/yourmoney-retired-pension-members-nma7-ti96: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, nj-gov/yourmoney-retired-pension-members-nma7-ti96 is just another Postgres schema.