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 local_law_18_pay_and_demographics_report_agency table in this repository, by referencing it like:
"cityofnewyork-us/local-law-18-pay-and-demographics-report-agency-423i-ukqr:latest"."local_law_18_pay_and_demographics_report_agency"or in a full query, like:
SELECT
":id", -- Socrata column ID
"gender", -- Gender category self-identified by the employee.
"race", -- Race category self-identified by the employee.
"upper_pay_band_bound", -- The upper bound of the pay band that an employee's pay falls in.
"pay_band", -- A pay band represents the minimum and maximum pay range of a specified width that an employee’s pay falls in.
"eeo_4_job_category", -- EEO-4 Job Category is used by the U.S. Equal Employment Opportunity Commission (EEOC) to classify a group of employees with comparable job responsibilities at comparable levels within an organization. DCAS classifies and maps each civil service title to one of the eight EEO-4 Job Categories as part of its legal mandate to submit EEO-4 reports every two years.
"lower_pay_band_bound", -- The lower bound of the pay band that employee's pay falls in.
"agency_name", -- Name of the agency the employee works for. Includes Local Law 18 covered agencies only.
"number_of_employees", -- Total number of employees in this group.
"ethnicity", -- Whether the employee is Hispanic or Latino, which is self-identified by the employee.
"employee_status", -- Whether an employee is a full-time, part-time, or seasonal. Full-time employees work a standard work week in a full-time title with a regular annual work schedule whereas part-time employees work fewer than 35 hours per week or are in titles having no standard hours per week or days per year. Seasonal employees such as lifeguards and many parks workers may work in either a part-time or full-time capacity.
"data_year" -- The year corresponding to the data. E.g. 2020 reflects pay and demographic data as of 12/31/2020 for full-time employees and as of 6/30/2020 for employees in seasonal titles.
FROM
"cityofnewyork-us/local-law-18-pay-and-demographics-report-agency-423i-ukqr:latest"."local_law_18_pay_and_demographics_report_agency"
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 cityofnewyork-us/local-law-18-pay-and-demographics-report-agency-423i-ukqr 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 cityofnewyork-us/local-law-18-pay-and-demographics-report-agency-423i-ukqr: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 cityofnewyork-us/local-law-18-pay-and-demographics-report-agency-423i-ukqrCheckout 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 cityofnewyork-us/local-law-18-pay-and-demographics-report-agency-423i-ukqr:latestThis will download all the objects for the latest tag of cityofnewyork-us/local-law-18-pay-and-demographics-report-agency-423i-ukqr 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 cityofnewyork-us/local-law-18-pay-and-demographics-report-agency-423i-ukqr: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 cityofnewyork-us/local-law-18-pay-and-demographics-report-agency-423i-ukqr: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, cityofnewyork-us/local-law-18-pay-and-demographics-report-agency-423i-ukqr is just another Postgres schema.