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_agency_payroll table in this repository, by referencing it like:
"nj-gov/yourmoney-agency-payroll-iqwc-r2w7:latest"."yourmoney_agency_payroll"or in a full query, like:
SELECT
":id", -- Socrata column ID
"master_section_desc", -- The area of the department to which the employee is assigned at the end of the reporting period.
"record_type", -- Identifies master or detail record for an employee.
"cash_in_lieu_maintenance", -- Contractual biweekly payment for State Police Employee Relations Groups.
"lump_sum_pay", -- Wages paid to an employee upon retirement for any unused sick leave accrued. The maximum payout is $15,000 per employee.
"clothing_uniform_payments", -- Wages paid to eligible employees for clothing and uniform purchase and maintenance.
"one_time_payments", -- Wages paid as bonus and one-time payments or shift differential for employees working night or evening shifts.
"paid_department_agency_desc", -- Discrete organization within the State of New Jersey that made payments to the employee.
"master_ytd_earnings", -- Sum of all payments for the employee during the reporting period; that is, the sum of the previous three columns.
"master_ytd_all_other_payments", -- The sum of wages for one or more departments/agencies that are earned by an employee not listed under regular pay or overtime payments during the reporting period.
"master_ytd_regular_pay", -- The sum of wages for one or more departments/agencies that are earned by an employee for working a predetermined number of hours or days in a week as dictated by the employee’s title during the reporting period.
"employee_relations_group", -- Classification indicating whether employee is aligned or not aligned with a union and what type of work that unit performs. This grouping determines what salary and benefits the employee receives. This is the employee relations group associated with the employee at the end of the reporting period.
"master_title_desc", -- The title is a descriptive name that identifies a position or group of positions with similar duties, responsibilities and qualifications. This is the title associated with the employee at the end of the reporting period.
"full_name", -- Full name of the employee at the end of the reporting period.
"middle_initial", -- Middle initial of the employee at the end of the reporting period.
"last_name", -- Last name of the employee at the end of the reporting period.
"master_ytd_overtime_payments", -- The sum of overtime wages for one or more departments/agencies by an employee during the reporting period.
"compensation_method", -- Identifies the basis by which an employee’s regular pay will be calculated. This is the compensation method associated with the employee at the end of the reporting period.
"salary_hourly_rate", -- Depending on the value in the column Compensation Method, the value in this column is either the annual salary, hourly rate or a daily rate for the employee at the end of the reporting period. When the compensation method is ‘Part Time’ the salary listed has been adjusted to represent the part time percentage.
"original_employment_dte", -- ORIGINAL EMPLOYMENT DATE
"ytd_earnings", -- Sum of all payments for the employee by paid_department_agency_desc and paid_section_desc during the reporting period.
"retroactive_pay", -- Wages paid to an employee for a salary adjustment with a prior effective date.
"overtime_payments", -- Overtime wages.
"legislator_or_back_pay", -- Wages paid to an employee as determined by the Merit System Board or other legal decision. Also used for Legislators and Legislative Aides pay.
"supplemental_pay", -- Wages paid to an employee that were not included in regular pay. In some existing state contracts, supplemental payments for overtime are required. Includes lump sum payments of unused vacation leave, compensatory time, and personal leave bank time.
"regular_pay", -- Wages earned by an employee for working a predetermined number of hours or days in a week as dictated by the employee’s title.
"paid_section_desc", -- The area of the paid department that made payment to the employee.
"master_department_agency_desc", -- Discrete organization within the State of New Jersey associated with the employee at the end of the reporting period.
"first_name", -- First name of the employee at the end of the reporting period. The literal ‘none’ has been used when there is no first name on record.
"payroll_id", -- Randomly generated number that helps pair a master record with its detail record(s).
"as_of_date", -- The last day of the quarter of data represented in this dataset.
"calendar_quarter", -- Payroll data will be published quarterly. The single digit calendar quarter represents the end of the period that the data spans and not the actual quarter that the payment was made. For example, when calendar quarter is set to ‘2’, the data would include payments made from January through June for the given calendar year. Calendar year and calendar quarter together represent the end of the reporting period.
"calendar_year" -- 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 employee. Calendar year and calendar quarter together represent the end of the reporting period.
FROM
"nj-gov/yourmoney-agency-payroll-iqwc-r2w7:latest"."yourmoney_agency_payroll"
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-agency-payroll-iqwc-r2w7 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-agency-payroll-iqwc-r2w7: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-agency-payroll-iqwc-r2w7Checkout 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-agency-payroll-iqwc-r2w7:latestThis will download all the objects for the latest tag of nj-gov/yourmoney-agency-payroll-iqwc-r2w7 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-agency-payroll-iqwc-r2w7: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-agency-payroll-iqwc-r2w7: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-agency-payroll-iqwc-r2w7 is just another Postgres schema.