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_residential_clothes_dryers table in this repository, by referencing it like:
"energystar-gov/energy-star-certified-residential-clothes-dryers-t9u7-4d2j:latest"."energy_star_certified_residential_clothes_dryers"or in a full query, like:
SELECT
":id", -- Socrata column ID
"paired_energy_star_clothes_washer_available", -- Indicates if the clothes dryer is being marketed as a matched pair with an ENERGY STAR Clothes Washer.
"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.
"date_qualified", -- The date on which the product was confirmed to meet the ENERGY STAR specification.
"energy_test_cycle_information", -- The cycle selection and settings (temperature and dryness where separately selectable) as defined in the U.S. Department of Energy test procedure, Code of Federal Regulations, Title 10, Section 430, Subpart B, Appendix D2, Section 3.3, used for certification to ENERGY STAR.
"estimated_energy_test_cycle_time_min", -- The estimated energy test cycle time is the time taken to complete the test cycle necessary for ENERGY STAR certification. Products must complete the energy test cycle in less than 80 minutes in order to be certified as ENERGY STAR. The estimated test cycle time does not reflect actual consumer cycle times which vary as a result of load size, dampness, and composition.
"estimated_annual_energy_use_kwh_yr", -- The estimated annual energy use is based on the Combined Energy Factor and an annual usage of 283 cycles per year, as referenced by the U.S. Department of Energy test procedure, Code of Federal Regulations, Title 10, Section 430, Subpart B, Appendix D2. Actual energy consumption will vary on your usage patterns, including how often your run the dryer, what cycle you select, and load size. NOTE: For gas dryers the estimated annual energy use is expressed in kilowatt hours to allow for comparison, and represents the equivalent multi-source energy use of the product (e.g., natural gas or propane typically expressed in British thermal units (Btu)).
"combined_energy_factor_cef", -- CEF is the energy performance metric for ENERGY STAR clothes dryers; the higher the CEF the more efficient the clothes dryer. The metric has units lbs/kWh and is calculated by dividing the weight of the test load by the sum of the per cycle standby and off mode energy consumption and either the total per-cycle electricity dryer energy consumption or the total per-cycle gas dryer energy consumption expressed in kilowatt hours (kWh).
"height_inches", -- The height of the clothes dryer.
"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.
"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.
"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.
"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.
"paired_energy_star_clothes_washer_energy_star_model_identifier", -- Paired clothes washer ENERGY STAR Model Identifier .
"width_inches", -- The width of the clothes dryer.
"calculated_combined_energy_factor_max_dryness_setting_lbs_kwh", -- The Calculated CEF – Max Dry is a measure of the dryer’s energy performance in a more energy consumptive setting, namely the normal cycle with the highest dryness setting as defined in the ENERGY STAR Most Efficient 2017 criteria. The Calculated CEF – Max Dry should not be directly compared to the CEF field, which is tested using the medium dryness setting, and represents a rated rather than measured value. The CEF metric has units lbs/kWh and is calculated by dividing the weight of the test load by the sum of the per cycle standby and off mode energy consumption and either the total per-cycle electricity dryer energy consumption or the total per-cycle gas dryer energy consumption expressed in kilowatt hours (kWh).
"drum_capacity_cu_ft", -- This is the drum capacity of the clothes dryers in cubic feet as measured by the U.S. Department of Energy test procedure, Code of Federal Regulations, Title 10, Section 430, Subpart B, Appendix D2. Products with a drum capacity less than 4.4 cubic feet are considered compact.
"type", -- This field is used to indicate the fuel type used to heat the air necessary to dry the clothes, either electric or gas.
"product_type",
"date_available_on_market", -- The date that the model is available for purchase.
"model_name", -- An identifier assigned by the manufacturer or private labeler to a product or family/series of products for sales and marketing purposes.
"markets", -- Includes products sold in the U.S. and/or Canada and other ENERGY STAR partner countries.
"connected", -- Indicates whether the model offers advanced controls and increased functionality such as sending notifications when the dryer is done or allowing for a service center to remotely diagnose problems. Clothes dryers with connected functionality are smart grid ready; if linked with your energy provider or an energy management system these products can dynamically adjust their energy use, potentially lowering your electric bill.
"vented_or_ventless", -- Venting Configuration refers to how the clothes dryer exhausts heated air. Vented clothes dryers exhaust the evaporated moisture from the clothes dryer cabinet using a vent which typically leads to a building’s exterior. Ventless clothes dryers use a closed loop system with an internal condenser to remove the evaporated moisture from the heated air. Moisture is discharged from the cabinet and instead collected in a reservoir or drained through a tube.
"additional_dryer_features", -- Features applicable to the clothes dryer may include drum light, wrinkle prevention option, steam cycle, sanitization cycle, filter cleaning indicator, energy monitor/indicator, time remaining display, and supplementary drying system.
"meets_most_efficient_criteria", -- Indicates models meeting the Most Efficient criteria. The ENERGY STAR Most Efficient criteria recognizes the most efficient products among those that qualify for the ENERGY STAR. These exceptional products represent the leading edge in energy efficient products this year. For more information, please visit www.energystar.gov/mostefficient
"depth_inches", -- The depth of the clothes dryer.
"connected_demand_response_functionality_tested", -- Provides guidance about what you need in your home to enable connected capabilities like smart phone control, e.g. ‘WiFi’ or Zigbee.
"communication_standard_application_layer", -- Open Standard - Application Layer include SEP 1.x, SEP2.x, OpenADR, etc.
"special_type", -- Indicates if the clothes dryer is part of a laundry center.
"heat_pump_technology", -- Highly energy efficient heat pump technology typically heats, dehumidifies and circulates air in the dryer drum, so no vent is required. A Heat Pump model solely uses heat pump technology to dry clothes, while a Hybrid Heat Pump model uses a combination of heat pump technology and traditional electric resistance heating technology.
"refrigerant_type", -- Indicates the type of refrigerant used in the model.
"voltage",
"refrigerant_with_gwp", -- Refrigerants are substances that cool or heat and are often used in refrigeration and HVAC equipment. Heat pump dryers require refrigerants as well. Many refrigerants are harmful atmospheric pollutants that have a high global warming potential (GWP). Lower GWP alternative refrigerant options for clothes dryers include R-290.
"brand_name", -- An identifier assigned by the manufacturer or private labeler to a product or family/series of products for sales and marketing purposes.
"direct_on_premises_open_standard_based_interconnection" -- Connected appliances may or may not enable open-standards connectivity in the home. Consider the following illustrative examples: "Yes" An appliance that can directly communicate using Wi-Fi and OpenADR, or wired Ethernet and SEP 2.x; "No" An appliance that uses proprietary communications to/from the cloud, and is capable of supporting open-standards communications only in the cloud.
FROM
"energystar-gov/energy-star-certified-residential-clothes-dryers-t9u7-4d2j:latest"."energy_star_certified_residential_clothes_dryers"
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-residential-clothes-dryers-t9u7-4d2j 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-residential-clothes-dryers-t9u7-4d2j: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-residential-clothes-dryers-t9u7-4d2jCheckout 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-residential-clothes-dryers-t9u7-4d2j:latestThis will download all the objects for the latest tag of energystar-gov/energy-star-certified-residential-clothes-dryers-t9u7-4d2j 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-residential-clothes-dryers-t9u7-4d2j: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-residential-clothes-dryers-t9u7-4d2j: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-residential-clothes-dryers-t9u7-4d2j is just another Postgres schema.