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 closed_discrimination_complaint_cases_in_iowa table in this repository, by referencing it like:
"mydata-iowa-gov/closed-discrimination-complaint-cases-in-iowa-ha33-u9br:latest"."closed_discrimination_complaint_cases_in_iowa"or in a full query, like:
SELECT
":id", -- Socrata column ID
"education", -- "Yes" indicates that the complaint was associated with education.
"housing", -- "Yes" indicates that the complaint was associated with housing.
"date_closed", -- Date the discrimination case was closed.
"color", -- "Yes" indicates that the basis of the complaint is associated with the complainant's color.
"date_opened", -- Date the discrimination case was opened.
"nat_org", -- "Yes" indicates that the basis of the complaint is associated with the complainant's national origin.
"processing_days", -- Calculates the number of the days between the date the case was open to the date the case was closed.
"nat_org_type", -- Lists the complainant's national origin when the basis of the complain was associated with the complainant's national origin. Otherwise field is null.
"race", -- "Yes" indicates that the basis of the complaint is associated with the complainant's race.
"credit", -- "Yes" indicates that the complaint was associated with credit.
"closure_desc", -- Closure description highlights the reason for closing the discrimination case.
"fy", -- Fiscal Year (July 1 - June 30, labeled for the year that it ends) the discrimination case was closed.
"gender_identity", -- "Yes" indicates that the basis of the complaint is associated with the complainant's gender identity.
"religion", -- "Yes" indicates that the basis of the complaint is associated with the complainant's religion.
"race_type", -- Lists the complainant's race when the basis of the complain was associated with the complainant's race. Otherwise field is null.
"age", -- "Yes" indicates that the basis of the complaint is associated with the complainant's age.
"religion_type", -- Lists the complainant's religion when the basis of the complain was associated with the complainant's religion. Otherwise field is null.
"sex_orientation", -- "Yes" indicates that the basis of the complaint is associated with the complainant's sexual orientation.
"disability", -- "Yes" indicates that the basis of the complaint is associated with the complainant's disability.
"retaliation", -- "Yes" indicates that the basis of the complaint is associated with retaliation.
"creed", -- "Yes" indicates that the basis of the complaint is associated with the complainant's creed.
"public_accom", -- "Yes" indicates that the complaint was associated with public accommodations (public services and buildings)
"not_jurisdictional", -- "Yes" indicates that the case did NOT meet established jurisdictional requirements.
"pregnancy", -- "Yes" indicates that the basis of the complaint is associated with the complainant's pregnancy.
"employment", -- "Yes" indicates that the complaint was associated with employment.
"processor", -- Indicates whether the discrimination complaint was processed by ICRC, EEOC or a local agency
"family_status", -- "Yes" indicates that the basis of the complaint is associated with the complainant's familial status.
"sex_type", -- Lists the complainant's sex when the basis of the complain was associated with the complainant's sex. Otherwise field is null.
"not_timely", -- "Yes" indicates that the complaint was NOT received within 300 days of the alleged incident.
"marital_status", -- "Yes" indicates that the basis of the complaint is associated with the complainant's marital status.
"sex" -- "Yes" indicates that the basis of the complaint is associated with the complainant's sex.
FROM
"mydata-iowa-gov/closed-discrimination-complaint-cases-in-iowa-ha33-u9br:latest"."closed_discrimination_complaint_cases_in_iowa"
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 mydata-iowa-gov/closed-discrimination-complaint-cases-in-iowa-ha33-u9br with SQL in under 60 seconds.
This repository is an "external" repository. That means it's hosted elsewhere, in this case at mydata.iowa.gov. When you querymydata-iowa-gov/closed-discrimination-complaint-cases-in-iowa-ha33-u9br:latest on the DDN, we "mount" the repository using the socrata mount handler. The mount handler proxies your SQL query to the upstream data source, translating it from SQL to the relevant language (in this case SoQL).
We also cache query responses on the DDN, but we run the DDN on multiple nodes so a CACHE_HIT is only guaranteed for subsequent queries that land on the same node.
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 (like this repository), 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, where the author has pushed Splitgraph Images to the repository, you can "clone" and/or "checkout" the data using sgr cloneand sgr checkout.
Mounting Data
This repository is an external repository. It's not hosted by Splitgraph. It is hosted by mydata.iowa.gov, and Splitgraph indexes it. This means it is not an actual Splitgraph image, so you cannot use sgr clone to get the data. Instead, you can use the socrata adapter with the sgr mount command. Then, if you want, you can import the data and turn it into a Splitgraph image that others can clone.
First, install Splitgraph if you haven't already.
Mount the table with sgr mount
sgr mount socrata \
"mydata-iowa-gov/closed-discrimination-complaint-cases-in-iowa-ha33-u9br" \
--handler-options '{
"domain": "mydata.iowa.gov",
"tables": {
"closed_discrimination_complaint_cases_in_iowa": "ha33-u9br"
}
}'That's it! Now you can query the data in the mounted table like any other Postgres table.
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, mydata-iowa-gov/closed-discrimination-complaint-cases-in-iowa-ha33-u9br is just another Postgres schema.