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_ceiling_fans table in this repository, by referencing it like:
"energystar-gov/energy-star-certified-ceiling-fans-2te3-nmxp:latest"."energy_star_certified_ceiling_fans"or in a full query, like:
SELECT
":id", -- Socrata column ID
"markets", -- This list/dataset includes products sold in the U.S. and/or Canada and other ENERGY STAR partner countries.
"correlated_color_temperature_kelvin", -- A description of the "color" of a light source measured on the Kelvin (K) scale. CFLs are available in a range of color temperatures. Lower values (2700-3000K) mean the white light has a warmer (red-yellow) tone, while higher kelvin (4100-6500K) mean the white light has a cooler (bluer) tone.
"total_input_power_watts", -- Total power consumed by the light kit (luminaire) while in use.
"light_output_lumens", -- The amount of light emitted by the light source or light fixture. Fixtures (with removable light sources are measured at the light source and do not account for light lost from the fixture, while other fixtures, where the light source cannot be removed, are measured at the fixture level, only counting the light that escapes the fixture. Ceiling fan light kits shipped with ENERGY STAR Lamps do not have to meet minimum light output requirements.
"fan_power_consumption_standby_w", -- Power consumed by the fan when operating in standby mode, measured in Watts.
"ceiling_fan_efficiency_cfm_w", -- The ratio of the total airflow to the total power consumption, in units of cubic feet per minute per watt (CFM/W). For standard and hugger ceiling fans, this is a weighted efficiency based on the ceiling fan performance in low speed, high speed, and standby mode. For low-mount high-speed small-diameter ceiling fans, this is a weighted efficiency based on the ceiling fan performance in high speed and standby mode.
"energy_star_partner", -- An organization that signed a Partnership Agreement with EPA to manufacture or private label ENERGY STAR qualified certified products.
"additional_model_information", -- This column includes for the certified 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.
"date_qualified", -- The date on which the product was confirmed to meet the ENERGY STAR specification.
"lamp_model_number", -- A distinguishing identifier, usually alphanumeric, assigned to a product by the manufacturer or private labeler. This model number pertains only to the lamp.
"model_number", -- A distinguishing identifier, usually alphanumeric, assigned to a product by the manufacturer or private labeler.
"model_name", -- An identifier assigned by the manufacturer or private labeler to a product or family/series of products for sales and marketing purposes.
"ceiling_fan_size_diameters_in_inches", -- The measurement of the largest swept circle by any part of the fan blade assembly. In other words, the diameter of the ceiling fan.
"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.
"brand_name", -- An identifier assigned by the manufacturer or private labeler to a product or family/series of products for sales and marketing purposes.
"date_available_on_market", -- The date that the model is available for purchase.
"light_source_life_hours", -- The expected useful life of the light source. Measured differently depending on the technology of the light source. For example, LED lighting expected useful life is based on the estimated point at which only 70% of the original light output remains, while for older technologies, like fluorescent, estimated useful life is based on the measured median sample life.
"product_type", -- A standard ceiling fan is a low-speed small-diameter ceiling fan that hangs greater than 10 inches from the ceiling. A low-mount HSSD ceiling fan is a high-speed small-diameter ceiling fan with a blade thickness greater than 1/8 inch that operates within safe blade tip speed limits. A hugger ceiling fan is a low-speed small-diameter ceiling fan that hangs less than or equal to 10 inches from the ceiling.
"energy_star_lamp_pd_id", -- This column indicates the ENERGY STAR Unique ID (ESUID) number for the ENERGY STAR lamps that are shipped with the certified ceiling fan.
"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.
"ceiling_fan_components_warranty_years", -- Certified ceiling fans shall provide a warranty of at least 3 years for all non-lighting components.
"color_quality_cri", -- The Color Rendering Index (CRI) of a light source represents the degree of color shift objects undergo when illuminated by the light source as compared with the color of those same objects when illuminated by a reference source of comparable color temperature. The ENERGY STAR specifications require a CRI of at least 80. Incandescent lighting has a CRI of 100. Early fluorescent lighting had CRIs in the 60s, resulting in unpleasant appearance of skin tones.
"indoor_outdoor", -- This column indicates whether the ceiling fan is intended for indoor use only or can be used outdoors.
"lamp_manufacturer", -- An organization that signed a Partnership Agreement with EPA to manufacture or private label ENERGY STAR certified products.
"fan_power_consumption_low_speed_w", -- Power consumed by the fan when operating at low speed, measured in Watts.
"energy_efficiency_measured_outside_the_fixture_lm_w", -- Proposed field definition: The quotient of the total luminous flux (lumens) emitted by the fixture over the total power input (Watts). It is expressed in lumens per watt (lm/W).
"notes", -- Indicates information on certification relevant to the consumer (i.e. product variations, unique issues concerning the model’s listing, etc.).
"communication_standard_media_network_layer", -- Provides guidance about what you need in your home to enable connected capabilities like smart phone control (e.g., Wi-Fi or ZigBee).
"light_kit_warranty", -- Certified ceiling fan light kits with replaceable drivers shall provide a warranty of at least 3 years. Certified ceiling fan light kits with non-replaceable drivers shall provide a warranty of at least 5 years.
"special_features_dimming_motion_sensing_etc", -- Most fixtures are designed to operate on an on/off switch. However, some fixtures have been designed with features to perform in specialized applications, such as with dimmers, three-way, or photo cell controls. Special features and compatibility with controls should be clearly marked on the product packaging, cut sheet or web site for the product.
"light_kit_dimmability", -- This column indicates whether the light kit is dimmable or not.
"light_sources_per_light_kit", -- The number of light sources included in each light kit.
"energy_star_lamp_alternate_pd_ids", -- This column indicates alternate ENERGY STAR Unique ID (ESUID) number(s) for the ENERGY STAR lamps that are shipped with the certified ceiling fan.
"ceiling_fan_features", -- Additional sensors that may be built into a ceiling fan to provide added convenience and to increase energy savings.
"power_factor", -- Ratio of real power flowing to the lamp to the apparent power in the circuit. A lamp with a lower power factor will draw more current than a lamp with a higher power factor of the same wattage.
"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
"light_source_connection_base_type", -- Light sources can be fully integrated into a light kit or removable by a consumer by custom connectors, wire nuts, pronged plugs like GU10, GU24 or sockets e.g. E26 known as the Edison base.
"fan_power_consumption_high_speed_w", -- Power consumed by the fan when operating at high speed, measured in Watts.
"shipped_with_energy_star_lamp_s_formula", -- For ceiling fans with a light kit, this column indicates whether the ceiling fan is shipped with ENERGY STAR certified lamps
"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.
"connected_functionality", -- Indicates whether the model offers advanced controls and increased functionality such as the ability to turn off the unit remotely when not at home and feedback on the energy use of the product. Connected functionality is optional and ceiling fans may be certified without it.
"lighting_technology", -- The light source technology utilized by the fixture: compact fluorescent light (CFL) or light emitting diode (LED).
"lighting_efficiency_measured_at_the_source_lm_w" -- Proposed field definition: The quotient of the total luminous flux (lumens) emitted by the light source over the total power input (Watts). It is expressed in lumens per watt (lm/W).
FROM
"energystar-gov/energy-star-certified-ceiling-fans-2te3-nmxp:latest"."energy_star_certified_ceiling_fans"
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-ceiling-fans-2te3-nmxp 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-ceiling-fans-2te3-nmxp: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-ceiling-fans-2te3-nmxpCheckout 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-ceiling-fans-2te3-nmxp:latestThis will download all the objects for the latest tag of energystar-gov/energy-star-certified-ceiling-fans-2te3-nmxp 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-ceiling-fans-2te3-nmxp: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-ceiling-fans-2te3-nmxp: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-ceiling-fans-2te3-nmxp is just another Postgres schema.