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_displays table in this repository, by referencing it like:
"energystar-gov/energy-star-certified-displays-qbg3-d468:latest"."energy_star_certified_displays"or in a full query, like:
SELECT
":id", -- Socrata column ID
"tiled_display_system", -- Is the Signage Display model tested as a Tiled Display System?
"monitor_total_energy", -- This calculation (for Computer Monitors only) assumes a daily duty cycle of 35% in On Mode and 65% hours in Sleep Mode over the course of a year. Signage Displays must meet On Mode, Sleep Mode, and Off Mode power requirements.
"maximum_tiled_configuration", -- The number of Signage Display panels in the Maximum Tiled Configuration.
"maximum_total_energy", -- The maximum Total Energy Consumption requirement for a Computer Monitor model with the given Screen Area and Resolution to qualify for ENERGY STAR. The Total Energy Consumption cannot exceed this value. Signage Displays must meet On Mode, Sleep Mode, and Off Mode power requirements.
"on_mode_power_at_300_lux", -- For ABC-enabled displays, this is the on-mode power drawn by the display in a room with bright ambient light.
"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.
"model_features", -- Additional features and networking options available on the display.
"signal_or_data_interfaces", -- Available methods of delivering content to the display.
"on_mode_power_watts", -- The power mode in which the product has been activated, and is providing one or more of its principal functions. The common terms "active," "in-use," and "normal operation" also describe this mode. The power in this mode is typically greater than the power in Sleep Mode and Off Mode.
"off_mode_power_watts", -- The power mode in which the product is connected to a power source, and is not providing any On Mode or Sleep Mode functions. This mode may persist for an indefinite time. The product may only exit this mode by direct user actuation of a power switch or control. Some products may not have this mode.
"reported_contrast_ratio_at_1", -- Display contrast ratio at +85 degrees from the perpendicular, expressed as a integer relative to 1 (e.g., 1000 means 1000:1).
"date_available_on_market", -- The date that the model is available for purchase.
"date_certified", -- The date on which the product was confirmed to meet the ENERGY STAR specification.
"markets", -- Includes products sold in the U.S. and/or Canada and other ENERGY STAR partner countries.
"color_gamut", -- The range of color supported within the CIE LUV 1976 u' v' color space and calculated per Section 5.18 Gamut Area of the Information Display Measurements Standard Version 1.03.
"total_native_resolution", -- The fixed physical pixel count of the display.
"power_source", -- Available methods of delivering power to the display.
"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.
"reported_contrast_ratio_at", -- Display contrast ratio at -85 degrees from the perpendicular, expressed as a integer relative to 1 (e.g., 1000 means 1000:1).
"on_mode_power_at_12_lux_at_115_volts_w", -- For ABC-enabled displays, this is the on-mode power consumed by the display in a room with low ambient light.
"features_enabled_in_default_1", -- Features enabled in the default tested Sleep Mode.
"maximum_luminance_candelas", -- The photometric measure of the luminous intensity per unit area of light travelling in a given direction, expressed in candelas per square meter (cd/m^2). Luminance refers to the brightness settings of a display.
"color_spaces_supported", -- A color space is a defined range of colors. Well known color spaces include sRGB, AdobeRGB and DCI-P3. Color spaces listed here are fully supported (100% of the defined range) by the Display.
"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
"enhanced_performance_display", -- A computer monitor that has all of the following features and functionalities: (a) A contrast ratio of at least 60:1 measured at a horizontal viewing angle of at least 85° from the perpendicular on a flat screen or 83° on a curved screen, with or without a screen cover glass; (b) A native resolution greater than or equal to 2.3 megapixels (MP); and, (c) A color gamut 32.9% of CIE LUV.
"features_enabled_in_default", -- Features enabled in the default tested On Mode.
"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.
"usb_c_with_power_delivery", -- Does the model tested include a USB Type C port with Power Delivery capability?
"screen_area_square_inches", -- The visible area of the Display that produces images.
"maximum_power_delivery_w", -- The rated or reported maximum power which the model can deliver via USB-C connection (W).
"high_dynamic_range_hdr", -- The HDR performance level for models that meet the VESA DisplayHDR CTS v1.0 Section 5.1 criteria. The model must meet the HDR performance level for all three white luminance criteria, including the 10% Center Patch Minimum Requirement (cd/m2), Full-screen Flash Minimum Requirement (cd/m2), and Full-screen Long-duration Minimum Requirement (cd/m2). N/A if the model does not meet the VESA DisplayHDR criteria.
"model_name", -- An identifier assigned by the manufacturer or private labeler to a product or family/series of products for sales and marketing purposes.
"maximum_sleep_mode_power", -- The maximum Sleep Mode power requirement for a Signage Display model with the particular features to qualify for ENERGY STAR. The Power Consumption in Sleep Mode cannot exceed this value. Computer Monitors must meet Total Energy Consumption requirements.
"maximum_on_mode_power_limit", -- The maximum On Mode power requirement for a Signage Display model with the given Screen Area and Maximum Reported Luminance to qualify for ENERGY STAR. The Power Consumption in On Mode cannot exceed this value. Computer Monitors must meet Total Energy Consumption requirements.
"display_contrast_ratio_at", -- Display contrast ratio at 0 degrees from the perpendicular, expressed as a integer relative to 1 (e.g., 1000 means 1000:1).
"panel_type", -- The most common screen types include TN LCD, IPS LCD, VA LCD, OLED, and Plasma.
"screen_size_inches", -- The diagonal screen size in inches.
"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.
"display_type", -- The 2 types of Displays eligible for ENERGY STAR certification are: Computer Monitors and Signage Displays.
"sleep_mode_power_watts", -- The power mode the product enters after receiving a signal from a connected device or an internal stimulus. The product may also enter this mode by virtue of a signal produced by user input. The product must wake on receiving a signal from a connected device, a network, a remote control, and/or an internal stimulus. While the product is in this mode, it is not producing a visible picture, with the possible exception of user-oriented or protective functions such as product information or status displays, or sensor-based functions.
"native_resolution_pixels", -- The fixed physical pixel count of the display.
"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.
"energy_star_partner", -- An organization that signed a Partnership Agreement with EPA to manufacture or private label ENERGY STAR qualified products
"brand_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-displays-qbg3-d468:latest"."energy_star_certified_displays"
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-displays-qbg3-d468 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-displays-qbg3-d468: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-displays-qbg3-d468Checkout 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-displays-qbg3-d468:latestThis will download all the objects for the latest tag of energystar-gov/energy-star-certified-displays-qbg3-d468 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-displays-qbg3-d468: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-displays-qbg3-d468: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-displays-qbg3-d468 is just another Postgres schema.