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 energy_star_certified_commercial_dishwashers table in this repository, by referencing it like:
"energystar-gov/energy-star-certified-commercial-dishwashers-pk8q-dim8:latest"."energy_star_certified_commercial_dishwashers"or in a full query, like:
SELECT
":id", -- Socrata column ID
"additional_model_information", -- This column includes for the qualified model or family, family members, additional model names, model numbers and other identifying information associated with a product or family/series of products for sales and marketing purposes. Other identifying information includes, but is not limited to, SKUs, UPC codes, retail numbers, and/or descriptions of models included/not included in the reported Model Family.
"energy_star_partner", -- An organization that signed a Partnership Agreement with EPA to manufacture or private label ENERGY STAR qualified products.
"energy_saver_mode_idle_rate_kw", -- If a dishwasher has an energy saver mode, this represents the measured Energy Saver Mode Idle Energy Rate.
"idle_energy_rate_for_low_temp_kw", -- For all dishwasher types, the dishwasher is considered "in idle mode" when it is not actively running but is still powered on and ready to wash dishes at the required temperature. The idle energy rate is the rate of energy consumed by the dishwasher while “holding” or maintaining wash tank water at the thermostat(s) set point.
"booster_heater_idle_energy_rate_for_high_temp_and_dual_sanitizi", -- If the booster heater idle energy rate was able to be measured separately (it is not inseparable), then this represents the booster heater idle energy consumption in kW.
"water_use_gallons_per_rack_gpr", -- Metric that represents the amount of water, in gallons, that is consumed while rinsing and sanitizing one rack of dishware. This water consumption metric is used to qualify under counter, single tank door, pot, pan, and utensil, single tank rack conveyor, and multiple tank rack conveyor machines.
"date_available_on_market", -- The date that the model is available for purchase.
"markets", -- Includes products sold in the U.S. and/or Canada and other ENERGY STAR partner countries.
"energy_saver_mode", -- An operational setting that is designed to reduce energy during idle mode through temporary shut-down of certain machine components (pumps or belt motors) or reduction of certain temperature set points.
"hot_water_energy_offset_kwh_rack", -- If the dishwasher claims the hot water energy offset, this represents the hot water energy offset in kWh/rack, calculated with Equation 1 of the Specification.
"sanitation_method", -- Describes the method for which the commercial dishwasher machine applies hot water or a chemical sanitizing solution for the purposes of cleaning dishware. Dual Sanitizing machines must meet both the high temp and low temp requirements.
"water_use_gallons_per_hour_gph", -- Metric that represents the amount of water, in gallons, that is consumed while rinsing and sanitizing dishware in one hour by the dishwashing machine. This water consumption metric is used for single tank flight type and multiple tank flight type machines.
"hot_water_energy_offset_claimed", -- Indicates if the product is claiming the Hot Water Energy Offset provided in Equation 1 of the Specification. The machine must meet the definition for Heat Recovery Machine in Section 1 of the Specification to claim this offset.
"heat_recovery_features", -- The following types of energy heat recovery features are possible: Exhaust Heat Exchanger; Wash Compartment Heat Exchanger; Supplemental Heat Pump; Drain Water Heat Exchanger; Other Energy Recovery.
"inseparable_booster_heater", -- Describes if the dishwasher has a booster heater that is inseparable. A booster heater is a water heater that raises the temperature of preheated water 40 to 80°F. The preheated water is supplied to the unit [booster heater] at temperatures that are typically between100 and 140°F. This booster heater can be either integral to the dishwasher, or externally connected. The booster heater (internal or external) energy consumption shall be measured and reported separately, if possible. However, if booster energy cannot be measured separately it will be included in the idle energy rate measurements.
"racks_per_hour", -- The racks per hour for this dishwasher.
"upc", -- UPC codes provided by partners for ENERGY STAR certified products. The brand, model name and model number continue to serve as the identifiers used to establish certification. The UPC code data below is intended to aid in identification of ENERGY STAR models. UPC code data is not provided for all certified models.
"idle_energy_rate_for_high_temp_kw", -- For all dishwasher types, the dishwasher is considered "in idle mode" when it is not actively running but is still powered on and ready to wash dishes at the required temperature. The idle energy rate is the rate of energy consumed by the dishwasher while “holding” or maintaining wash tank water at the thermostat(s) set point.
"pd_id", -- The ENERGY STAR Unique ID (ESUID) is a string of seven numbers EPA assigns to an ENERGY STAR model or set of models with unique performance characteristics. This ESUID is unique to both the model and product specification version and is assigned by EPA upon receipt of certification information from the certification body. Each row within the product list will have a unique ESUID. Developers may wish to use this ESUID to track information on certified models in their information systems.
"water_use_gallons_per_square_foot_gpsf", -- Metric that represents the amount of water, in gallons, that is consumed per one square foot of rack area while rinsing and sanitizing dishware. This water consumption metric is used for pot, pan, and utensil machines.
"brand_name", -- An identifier assigned by the manufacturer or private labeler to a product or family/series of products for sales and marketing purposes.
"pot_pan_utensil_machine_wash_area_ft2", -- The wash area available for pot, pan, and utensil dishmachines.
"date_qualified", -- The date on which the product was confirmed to meet the ENERGY STAR specification.
"energy_star_model_identifier", -- A unique string of characters assigned by certification bodies (CBs) to identify a model or set of models with the same performance characteristics. This identifier should remain the same for a model even if it is recertified to a new version of an ENERGY STAR specification. This string of characters is determined by CBs and is not the ENERGY STAR Unique ID assigned by EPA.
"machine_type", -- Designates the type of dishmachine model.
"heat_recovery_machine", -- "Warewashing equipment with heat recovery; a heat exchanger that recovers energy from other heat sources (i.e. waste water, exhaust duct) for the purpose of heating potable water. This includes but is not limited to drain water, wash compartment, and/or exhaust heat exchangers; and supplemental heat pumps. The equipment: 1) must use a minimum of 95% of water volume from the cold-water inlet for the wash and rinse cycle. The machine can have both cold-water and hot-water inlets, but a maximum of 5% of wash rinse cycle water shall come from the hot water; 2) must have an inlet water temperature of 70 ± 3°F; and 3) must operate at or above 180°F. "
"washing_energy_consumption_kwh_rack_for_high_temp_and_dual_sani", -- Metric that represents total washing energy, including any internal or external booster heater energy in addition to the tank, heat, motor, control, and any additional auxiliary energy, expressed in kWh/rack.
"model_number", -- A distinguishing, alphanumeric identifier, assigned to a product by the manufacturer or private labeler. The model number may include a wildcard that can be replaced by any letter or digit and still accurately capture what is covered by the model’s ENERGY STAR certification; an asterisk symbol (*) represents a letter, and a number symbol (#) a digit.
"washing_energy_consumption_kwh_rack_for_low_temp_and_dual_sanit", -- Metric that represents total washing energy, including any internal or external booster heater energy in addition to the tank, heat, motor, control, and any additional auxiliary energy, expressed in kWh/rack.
"model_name" -- An identifier assigned by the manufacturer or private labeler to a product or family/series of products for sales and marketing purposes.
FROM
"energystar-gov/energy-star-certified-commercial-dishwashers-pk8q-dim8:latest"."energy_star_certified_commercial_dishwashers"
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 energystar-gov/energy-star-certified-commercial-dishwashers-pk8q-dim8 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 energystar-gov/energy-star-certified-commercial-dishwashers-pk8q-dim8: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 energystar-gov/energy-star-certified-commercial-dishwashers-pk8q-dim8Checkout 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 energystar-gov/energy-star-certified-commercial-dishwashers-pk8q-dim8:latestThis will download all the objects for the latest tag of energystar-gov/energy-star-certified-commercial-dishwashers-pk8q-dim8 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 energystar-gov/energy-star-certified-commercial-dishwashers-pk8q-dim8: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 energystar-gov/energy-star-certified-commercial-dishwashers-pk8q-dim8: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, energystar-gov/energy-star-certified-commercial-dishwashers-pk8q-dim8 is just another Postgres schema.