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 new_york_state_commission_for_the_blind_nyscb table in this repository, by referencing it like:
"ny-gov/new-york-state-commission-for-the-blind-nyscb-gthh-7nri:latest"."new_york_state_commission_for_the_blind_nyscb"or in a full query, like:
SELECT
":id", -- Socrata column ID
"city", -- Business city of the agency providing the service.
"georeference", -- Open Data/Socrata-generated geocoding information from supplied address components.
"vocational_skills", -- Provides vocational skills training o experiential learning for service, clerical, industrial, or technology related occupations
"fax", -- Agecny fax number; n/a indicates none available.
"zip_code", -- Business zip of the agency providing the service
"assisted_living_program_3", -- Provides services to individuals who are primarily responsibility for managing the home. Rehabilitation services provided to an older individual who has significant needs AND primary responsibility for managing the home
"address", -- Business address of the agency providing the service.
"assisted_living_program_2e", -- Provides enhanced Assistive Living Services - rehabilitation services provided to an older individual who requires services in excess of the typical ALP-2 program in order to achieve his/her goals.
"assisted_living_program_1", -- Provides assistive Living Program assessments, eligibility recommendations, and service plan development
"social_casework_level_2", -- Provides social work case work level 2 on therapeutic interventions
"assisted_living_program_2", -- Provides assistive Living Services - rehabilitation services provided to an older individual to assist him/her to achieve a greater level of safety and confidence in the living environment.
"comprehensive_service_contract", -- Has a comprehensive services contract with core services (vision rehabilitation therapy, orientation and mobility, and social casework)
"phone_number", -- Business contact phone number of the agency providing the service
"pre_vocationa_young_adults", -- Provides pre vocational skills training for youth adults
"work_experience", -- Provides work experience training to understand the work environment
"job_placement_service_dve_contract", -- Has a job placement service or diagnostic vocational evaluation (DVE) contract
"diagnostic_vocational_evaluation", -- Provides comprehensive testing to assist in the determination of eligibility or development of a vocational goal to clarify issues which may be impeding vocational rehabilitation services
"work_readiness", -- Provides work readiness training to create positive work-related behaviors
"academic_instruction", -- Provides academic instructions to improve academic achievement levels
"region_covered", -- 1 Western NY 3 Syracuse 4 Albany 5 White Plains 6 NYC Manhattan 7 Hampstead 8 Harlem Details provided in the overview document
"agency_name", -- Business name of the agency providing the service(s)
"orientation_mobility", -- Provides orientation and mobility training in safe travel techniques
"vision_rehab", -- Provides visual rehabilitation therapy training in manual dexterity, communications, home management, personal management use of adaptive devices
"state", -- Business state of the agency providing the service
"social_casework_level_1" -- Provides social case work at level 1
FROM
"ny-gov/new-york-state-commission-for-the-blind-nyscb-gthh-7nri:latest"."new_york_state_commission_for_the_blind_nyscb"
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/new-york-state-commission-for-the-blind-nyscb-gthh-7nri 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 ny-gov/new-york-state-commission-for-the-blind-nyscb-gthh-7nri: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 ny-gov/new-york-state-commission-for-the-blind-nyscb-gthh-7nriCheckout 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 ny-gov/new-york-state-commission-for-the-blind-nyscb-gthh-7nri:latestThis will download all the objects for the latest tag of ny-gov/new-york-state-commission-for-the-blind-nyscb-gthh-7nri 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 ny-gov/new-york-state-commission-for-the-blind-nyscb-gthh-7nri: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 ny-gov/new-york-state-commission-for-the-blind-nyscb-gthh-7nri: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, ny-gov/new-york-state-commission-for-the-blind-nyscb-gthh-7nri is just another Postgres schema.