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 wdfwhatchery_programs table in this repository, by referencing it like:
"wa-gov/wdfwhatchery-programs-8d7d-8in5:latest"."wdfwhatchery_programs"or in a full query, like:
SELECT
":id", -- Socrata column ID
"segrated_phos_rate_desc",
"net_caught_adult_desc",
"adult_where_returning_fish_go_spawning_grounds_desc",
"life_stage", -- Life stage of the hatchery release.
"facility_name", -- The name of the hatchery.
"hatchery_program_name", -- Name of the hatchery program at the hatchery.
"pni_year", -- Year PNI/pHOS was calculated.
"species", -- Common name for the species.
"adult_returns_to_hatchery_wild_broodstock_pct", -- Reflects the percent of the fish spawned at the hatchery that are wild fish - unclipped adults that have been produced from the spanwing grounds, not the hatchery. In integrated hatchery programs, there is a goal for the percentage of wild fish that should make up the broodstock.
"adult_where_returning_fish_go_hatchery_desc",
"segrated_phos_goal_desc",
"production_goal", -- Production goal the hatchery plans to produced from WDFW Hatchery Broodstock database. Based on Broodstock Production Goal for 2010-2011.
"integrated_pni_rate", -- Proportionate natural influence on a composite hatchery/natural-origin population. Can also be thought of as the percentage of time the genes of a composite population spend in the natural environment. Equals pNOB/(pNOB + pHOS).
"integrated_pni_goal_desc",
"adult_returns_to_hatchery_excess", -- Number of adults that returned to the hatchery, but were not needed to meet the hatchery's production goal. These fish are provided to food banks, used in nutrient enhancement programs or provided to the contracted buyer.
"adult_returns_to_hatchery_excess_desc",
"segrated_phos_rate", -- Proportion of natural spawners composed of HORs. Equals HOS/(NOS + HOS).
"run", -- Run timing of the fish.
"integrated_pni_rate_desc",
"juvenile_produced", -- Data from WDFW Hatchery Plants database plant years from 2007-2009.
"juvenile_to_smolt_survival_desc",
"actual_adult_hatchery_produced", -- Total adults returning to Hatchery, Spawning grounds, and harvested in Sport, Commercial Troll and Net, and Non-WA fisheries.
"adult_returns_to_hatchery_broodstock_total", -- Total number of adult male and female fish that are needed to have enough fertilized eggs to meet the hatchery's production goal. (This may be more than needed for just the on-station release).
"juvenile_to_smolt_survival_pct", -- The percentage of released juveniles that survive and become adults - (includes total harvest, return to the hatchery or the spawning grounds) is presented here.
"county", -- The county the hatchery is located in.
"lead_entity", -- See: http://www.rco.wa.gov/salmon_recovery/lead_entities.shtml
"adult_where_returning_fish_go_spawning_grounds_pct", -- Based on Coded Wire Tags (CWT), estimates are made of where returning hatchery adults go - back to hatchery, harvested or to the spawning grounds. Numbers here are the percentage of hatchery fish that go back to hatchery, spawning grounds and are harvested. Data source: CWT data for BY 96-01.
"goal", -- Goal of the hatchery program.
"integrated_pni_goal", -- Production goal the hatchery plans to produced from WDFW Hatchery Broodstock database. Based on Broodstock Production Goal for 2010-2011.
"sport_caught_adult_desc",
"salmon_recovery_region", -- See: http://www.rco.wa.gov/salmon_recovery/regions/regional_orgs.shtml
"non_wa_caught_adult_desc",
"segrated_phos_goal", -- Production goal the hatchery plans to produced from WDFW Hatchery Broodstock database. Based on Broodstock Production Goal for 2010-2011.
"cost_per_adult_desc",
"last_updated",
"cost_per_adult", -- 1. Pro-rating the operating budget across all on-station and off-station production at the hatchery (pounds of production); then prorated by species (pounds of production) on station. 2. Cost of mass marking was added to pro-rated cost. 3. Then dividing cost by number of adults produced. 4. Costs of CWT were not included.
"adult_where_returning_fish_go_harvested_desc",
"wria", -- See: http://www.ecy.wa.gov/apps/watersheds/wriapages/
"adult_returns_to_hatchery_wild_broodstock_desc",
"adult_returns_to_hatchery_broodstock_desc",
"actual_adult_hatchery_produced_desc",
"adult_where_returning_fish_go_harvested_pct", -- Based on Coded Wire Tags (CWT), estimates are made of where returning hatchery adults go - back to hatchery, harvested or to the spawning grounds. Numbers here are the percentage of hatchery fish that go back to hatchery, spawning grounds and are harvested. Data source: CWT data for BY 96-01.
"adult_where_returning_fish_go_hatchery_pct", -- Based on Coded Wire Tags (CWT), estimates are made of where returning hatchery adults go - back to hatchery, harvested or to the spawning grounds. Numbers here are the percentage of hatchery fish that go back to hatchery, spawning grounds and are harvested. Data source: CWT data for BY 96-01.
"non_wa_caught_adult", -- Based on Coded Wire Tags (CWT), this is the breakdown of the number of fish harvested by Non-Washington and Washington fisheries. Washington fisheries are further broken down into: Non-Washington Fisheries and Washington fisheries (Sport, Troll* and Net*) Troll and Net fisheries include both Treaty and Non-Treaty harvest.
"sport_caught_adult", -- Based on Coded Wire Tags (CWT), this is the breakdown of the number of fish harvested by Non-Washington and Washington fisheries. Washington fisheries are further broken down into: Non-Washington Fisheries and Washington fisheries (Sport, Troll* and Net*) Troll and Net fisheries include both Treaty and Non-Treaty harvest.
"net_caught_adult", -- Based on Coded Wire Tags (CWT), this is the breakdown of the number of fish harvested by Non-Washington and Washington fisheries. Washington fisheries are further broken down into: Non-Washington Fisheries and Washington fisheries (Sport, Troll* and Net*) Troll and Net fisheries include both Treaty and Non-Treaty harvest.
"hatchery_program_type", -- Type of the program. Either integrated or segregated.
"troll_caught_adult_desc",
"troll_caught_adult" -- Based on Coded Wire Tags (CWT), this is the breakdown of the number of fish harvested by Non-Washington and Washington fisheries. Washington fisheries are further broken down into: Non-Washington Fisheries and Washington fisheries (Sport, Troll* and Net*) Troll and Net fisheries include both Treaty and Non-Treaty harvest.
FROM
"wa-gov/wdfwhatchery-programs-8d7d-8in5:latest"."wdfwhatchery_programs"
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 wa-gov/wdfwhatchery-programs-8d7d-8in5 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 wa-gov/wdfwhatchery-programs-8d7d-8in5: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 wa-gov/wdfwhatchery-programs-8d7d-8in5Checkout 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 wa-gov/wdfwhatchery-programs-8d7d-8in5:latestThis will download all the objects for the latest tag of wa-gov/wdfwhatchery-programs-8d7d-8in5 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 wa-gov/wdfwhatchery-programs-8d7d-8in5: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 wa-gov/wdfwhatchery-programs-8d7d-8in5: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, wa-gov/wdfwhatchery-programs-8d7d-8in5 is just another Postgres schema.