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 directory_of_developmental_disabilities_service table in this repository, by referencing it like:
"ny-gov/directory-of-developmental-disabilities-service-ieqx-cqyk:latest"."directory_of_developmental_disabilities_service"or in a full query, like:
SELECT
":id", -- Socrata column ID
"individual_residential_alternative_ira", -- An Individualized Residential Alternative (IRA) is a type of community residence that provides room, board and individualized service options. Service provider offers services of this type (Y if yes, N if no) based on current enrollments.
"location_1_address",
"phone", -- Service provider agency main office zip code
"state", -- Service provider agency main office state
"location_1_zip",
"location_1", -- Open Data/Socrata-generated location data column. This column is used to provide Latitude and Longitude coordinates for creating a map of the data set.
"developmental_centers_and_special_population_services", -- Campus‐Based, Developmental Treatment Services (ICF/DC) settings are intended primarily for short-term interventions prior to returning to the community. They house individuals with major behavioral challenges and other highly intensive needs. Service provider offers services of this type (Y if yes, N if no) based on current enrollments.
"family_support_services", -- Family support services help an individual with developmental disabilities by supporting his or her family to care for him or her in the family home. Service provider offers services of this type (Y if yes, N if no) based on current enrollments.
"community_habilitation", -- Community habilitation helps individuals with developmental disabilities that live independently or at home with family to learn and experience community based activities. Service provider offers services of this type (Y if yes, N if no) based on current enrollments.
"supported_employment_enrollments", -- Supported Employment (SEMP) offers supports for individuals who are seeking competitive employment. Service provider offers services of this type (Y if yes, N if no) based on current enrollments.
"prevocational", -- Prevocational services assist individuals who are interested in employment but whose skills are such that they may not expect to obtain competitive employment within the next year. Service provider offers services of this type (Y if yes, N if no) based on current enrollments.
"individual_support_services_iss", -- Individual Supports Services (ISS) assists adults with developmental disabilities who wish to live independently by providing funds to pay for housing costs, and on a limited basis, for such things as food, transportation and clothing. Service provider offers services of this type (Y if yes, N if no) based on current enrollments.
"self_direction_services", -- Self-direction of services allows participants to have the responsibility for managing all aspects of service delivery. Self-direction of services with the exercise of employer authority, budget authority or both is the ultimate control that can be undertaken. Service provider offers services of this type (Y if yes, N if no) based on current enrollments. Service providers that offer self-direction employer authority only for community habilitation, supported employment, or respite are not included in this list.
"family_care", -- OPWDD’s Family Care program provides community-based residential housing in certified private homes for individuals with developmental disabilities. Service provider offers services of this type (Y if yes, N if no) based on current enrollments.
"county", -- Service provider agency main office county. Services offered may be delivered in the same or different county (or counties) than the county of the service provider agency main address listed. The county is not necessarily that of the DDSO.
"city", -- Service provider agency main office city
"street_address_line_2", -- Service provider agency main office address (second line)
"street_address", -- Service provider main office agency address
"developmental_disability_services_office", -- Name of the Developmental Disability Service Office(DDSO) area in which a Service provider’s main office is located. A DDSO is a sub-unit of an OPWDD regional/state operations office. Services may be delivered in the same or different DDSO than the DDSO of the service providers main address listed.
"zip_code", -- Service provider agency main office zip code
"service_provider", -- Service provider main office agency name
"location_1_state",
"day_habilitation", -- Day Habilitation services can assist individuals to acquire, retain or improve self-help, socialization and adaptive skills, including communication, travel and other areas in adult education. Service provider offers services of this type (Y if yes, N if no) based on current enrollments.
"intermediate_care_facilities_icf_s", -- ICFs serve individuals who are unable to care for their own basic needs, require heightened supervision and structure, support and resources The service provider offers services of this type (Y if yes, N if no) based on current enrollments.
":@computed_region_kjdx_g34t",
":@computed_region_wbg7_3whc",
":@computed_region_yamh_8v7k",
"url", -- Service provider agency World Wide Web Universal Resource Locator address (URL).
"location_1_city"
FROM
"ny-gov/directory-of-developmental-disabilities-service-ieqx-cqyk:latest"."directory_of_developmental_disabilities_service"
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/directory-of-developmental-disabilities-service-ieqx-cqyk 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/directory-of-developmental-disabilities-service-ieqx-cqyk: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/directory-of-developmental-disabilities-service-ieqx-cqyk" \
--handler-options '{
"domain": "data.ny.gov",
"tables": {
"directory_of_developmental_disabilities_service": "ieqx-cqyk"
}
}'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/directory-of-developmental-disabilities-service-ieqx-cqyk is just another Postgres schema.