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 aot_assisted_outpatient_treatment_court_orders table in this repository, by referencing it like:
"ny-gov/aot-assisted-outpatient-treatment-court-orders-r4sv-k333:latest"."aot_assisted_outpatient_treatment_court_orders"or in a full query, like:
SELECT
":id", -- Socrata column ID
"percent_of_petitions_granted", -- Percentage of filed petitions that were granted since Nov. 1999. For some counties, there are cells for which there is no reported data, or there are reports for 5 recipients or fewer. For those cells containing 5 recipients or fewer, the data are suppressed in order to protect confidentiality.
"renewed_court_orders", -- Number of court orders renewed since November 1999. Numbers are counts of unique recipients. For some counties, there are cells for which there is no reported data, or there are reports for 5 recipients or fewer. For those cells containing 5 recipients or fewer, the data are suppressed in order to protect confidentiality.
"currently_under_court_order", -- Number of people with a current court order. For some counties, there are cells for which there is no reported data, or there are reports for 5 recipients or fewer. For those cells containing 5 recipients or fewer, the data are suppressed in order to protect confidentiality.
"percent_12_to_18_months_in_aot", -- Percentage of all individuals court ordered since Nov 1999 who were in AOT for 12-18 months. For some counties, there are cells for which there is no reported data, or there are reports for 5 recipients or fewer. For those cells containing 5 recipients or fewer, the data are suppressed in order to protect confidentiality.
"percent_over_30_months_in_aot", -- Percentage of all individuals court ordered since Nov 1999 who were in AOT for over 30 months. For some counties, there are cells for which there is no reported data, or there are reports for 5 recipients or fewer. For those cells containing 5 recipients or fewer, the data are suppressed in order to protect confidentiality.
"omh_region", -- Name of the region where the county is located
"court_ordered_since_1999", -- Number of people for whom court orders were issued since the implementation of AOT (November 1999). For some counties, there are cells for which there is no reported data, or there are reports for 5 recipients or fewer. For those cells containing 5 recipients or fewer, the data are suppressed in order to protect confidentiality.
"percent_6_to_12_months_in_aot", -- Percentage of all individuals court ordered since Nov 1999 who were in AOT for 6-12 months. For some counties, there are cells for which there is no reported data, or there are reports for 5 recipients or fewer. For those cells containing 5 recipients or fewer, the data are suppressed in order to protect confidentiality.
"data_level_indicator", -- Data level indicator; indicates whether the row represents county, region, or statewide level data
"county", -- Name of the particular county or region, or whether it is Statewide
"percent_of_orders_renewed", -- Percentage of court orders renewed since Nov.1999. For some counties, there are cells for which there is no reported data, or there are reports for 5 recipients or fewer. For those cells containing 5 recipients or fewer, the data are suppressed in order to protect confidentiality.
"eligible_for_court_order_renewel", -- Number of recipients who were ever eligible for renewal; i.e., recipients who had an initial court order. Recipients with current/unexpired initial court orders are excluded because their orders have not become eligible for renewal. For some counties, there are cells for which there is no reported data, or there are reports for 5 recipients or fewer. For those cells containing 5 recipients or fewer, the data are suppressed in order to protect confidentiality.
"percent_18_to_30_months_in_aot", -- Percentage of all individuals court ordered since Nov 1999 who were in AOT for 18-30 months. For some counties, there are cells for which there is no reported data, or there are reports for 5 recipients or fewer. For those cells containing 5 recipients or fewer, the data are suppressed in order to protect confidentiality.
"row_created_date_time", -- Date and Time when data was generated (e.g. “12/19/2014 09:45:21”)
"percent_0_to_6_months_in_aot", -- Percentage of all individuals court ordered since Nov 1999 who were in AOT for 0-6 months. For some counties, there are cells for which there is no reported data, or there are reports for 5 recipients or fewer. For those cells containing 5 recipients or fewer, the data are suppressed in order to protect confidentiality.
"number_of_petitions_filed", -- Number of people for whom petitions were filed since Nov. 1999. For some counties, there are cells for which there is no reported data, or there are reports for 5 recipients or fewer. For those cells containing 5 recipients or fewer, the data are suppressed in order to protect confidentiality.
"number_of_petitions_granted" -- Number of people for whom petitions were granted since Nov. 1999. For some counties, there are cells for which there is no reported data, or there are reports for 5 recipients or fewer. For those cells containing 5 recipients or fewer, the data are suppressed in order to protect confidentiality.
FROM
"ny-gov/aot-assisted-outpatient-treatment-court-orders-r4sv-k333:latest"."aot_assisted_outpatient_treatment_court_orders"
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 ny-gov/aot-assisted-outpatient-treatment-court-orders-r4sv-k333 with SQL in under 60 seconds.
This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.ny.gov. When you queryny-gov/aot-assisted-outpatient-treatment-court-orders-r4sv-k333: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 data.ny.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 \
"ny-gov/aot-assisted-outpatient-treatment-court-orders-r4sv-k333" \
--handler-options '{
"domain": "data.ny.gov",
"tables": {
"aot_assisted_outpatient_treatment_court_orders": "r4sv-k333"
}
}'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, ny-gov/aot-assisted-outpatient-treatment-court-orders-r4sv-k333 is just another Postgres schema.