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 adult_care_facility_directory table in this repository, by referencing it like:
"health-data-ny-gov/adult-care-facility-directory-wssx-idhx:latest"."adult_care_facility_directory"or in a full query, like:
SELECT
":id", -- Socrata column ID
"regional_office", -- The Department of Health’s regional office that the Adult Care Facility is within. CDRO: Capital District Regional Office. CNYRO: Central New York Regional Office. MARO: Metropolitan Area Regional Office. WRO: Western Regional Office.
"classification", -- The classification of the Adult Care Facility. NFP: Not for Profit. PPHA: Private Proprietary Home for Adults.
":@computed_region_9yqb_tdyd", -- This column was automatically created in order to record in what polygon from the dataset 'Counties' (9yqb-tdyd) the point in column 'geocoded_column' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"number_of_beds", -- Refers to the maximum number of ACF beds allowed. These beds are certified by the NYSDOH under Article 7 of the New York State Public Health Law.
"assisted_living_program_beds", -- Refers to the maximum number of Assisted Living Programs (ALP) beds allowed.
"assisted_living_residence_alr_beds", -- Refers to the maximum number of Assisted Living Residence (ALR) beds allowed.
"geocoded_column_zip",
"enhanced_alr_beds", -- Refers to the maximum number of Enhanced Assisted Living Residence (EALR) beds allowed.
"geocoded_column_address",
"type", -- The type of Adult Care Facility. AH: Adult Home. ALP: Assisted Living Program. EHP: Enriched Housing Program.
"county", -- Refers to the county in which the facility is located
"address", -- The facility address
":@computed_region_5edz_4hdv", -- This column was automatically created in order to record in what polygon from the dataset 'School Districts 2016.shp' (5edz-4hdv) the point in column 'geocoded_column' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"geocoded_column_state",
":@computed_region_assa_msit", -- This column was automatically created in order to record in what polygon from the dataset 'NYS Senate Districts' (assa-msit) the point in column 'geocoded_column' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
":@computed_region_8ire_itmf", -- This column was automatically created in order to record in what polygon from the dataset 'Local Waterfront Revitalization Program (LWRP) Communities' (8ire-itmf) the point in column 'geocoded_column' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"special_needs_alr_beds", -- Refers to the maximum number of Special Needs Assisted Living Residence (SNALR) beds allowed.
"zip", -- Refers to the zip code in which the facility is located
"phone", -- Refers to the phone number of the facility
"operator", -- Refers to the operator of the facility
"certificate_number", -- The Operating Certificate Number of the facility
"facility_id", -- The ID of the facility
"facility_name", -- The facility name
":@computed_region_43an_4dx5", -- This column was automatically created in order to record in what polygon from the dataset 'New York Zip Codes' (43an-4dx5) the point in column 'geocoded_column' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"geocoded_column_city",
"city", -- Refers to the city in which the facility is located
"geocoded_column",
"fax" -- Refers to the facsimile number of the facility
FROM
"health-data-ny-gov/adult-care-facility-directory-wssx-idhx:latest"."adult_care_facility_directory"
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 health-data-ny-gov/adult-care-facility-directory-wssx-idhx 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 health-data-ny-gov/adult-care-facility-directory-wssx-idhx: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 health-data-ny-gov/adult-care-facility-directory-wssx-idhxCheckout 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 health-data-ny-gov/adult-care-facility-directory-wssx-idhx:latestThis will download all the objects for the latest tag of health-data-ny-gov/adult-care-facility-directory-wssx-idhx 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 health-data-ny-gov/adult-care-facility-directory-wssx-idhx: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 health-data-ny-gov/adult-care-facility-directory-wssx-idhx: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, health-data-ny-gov/adult-care-facility-directory-wssx-idhx is just another Postgres schema.