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 dir_sts_enterprise_invoices table in this repository, by referencing it like:
"texas-gov/dir-sts-enterprise-invoices-gp4s-vej8:latest"."dir_sts_enterprise_invoices"or in a full query, like:
SELECT
":id", -- Socrata column ID
"business_line", -- Name of STS Service Tower
"date", -- Invoice Month
"resource_unit_sub_group", -- Invoice hierarchy used for summarizing Resource Unit charges at a higher level
"base_units", -- Metric applied to Resource Units
"vendor", -- Name of Billing Entity
"arc_rrc_units", -- Additional Resource Charges or Reduced Resource Credits were incremental monthly adjustments (Resource Actual Units – Base Units) to the Base Units used to calculate the Monthly Charge prior to 9/1/2020 under the base + variable pricing model.
"arc_rrc_charges", -- Prior to 9/1/2020, under the base + variable pricing model, incremental charge adjustments associated with ARC/RRC Units. Effective 9/1/2020, this charge is the monthly charge.
"chargeback_rate", -- The rate used to invoice customers for chargeback purposes.
"total_charges_to_dir", -- ARC/RRC Charges plus PPA Costs. Prior to 9/1/2020, Monthly Charge + ARC/RRC Charges + PPA Costs.
"ppa_costs", -- Prior Period Adjustments
"service_provider_eca", -- Prior to 9/1/2020, the amount represents the contractual Economic Change Adjustment.
"vendor_resource_unit", -- Measurable unit of consumption by vendor
"rate_1", -- Unit Rate used to calculate charges. Prior to 9/1/2020 this was the ARC/RRC rate for units over the base.
"other_charges_and_credits", -- Prior to 9/1/2020, the amount represents pricing discounts.
"rate_2", -- Unit rate used to calculate Print Mail charges prior to 9/1/2020 when volumes were 25%-50% over the base.
"monthly_charge", -- Total monthly base charges, invoiced by Service Provider prior to 9/1/2020 under the base + variable pricing model.
"resource_unit", -- Measurable unit of consumption
"resource_unit_group", -- Invoice hierarchy used for summarizing Resource Unit charges at a higher level
"resource_actual_units" -- Resource units consumed for the billing month
FROM
"texas-gov/dir-sts-enterprise-invoices-gp4s-vej8:latest"."dir_sts_enterprise_invoices"
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 texas-gov/dir-sts-enterprise-invoices-gp4s-vej8 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 texas-gov/dir-sts-enterprise-invoices-gp4s-vej8: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 texas-gov/dir-sts-enterprise-invoices-gp4s-vej8Checkout 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 texas-gov/dir-sts-enterprise-invoices-gp4s-vej8:latestThis will download all the objects for the latest tag of texas-gov/dir-sts-enterprise-invoices-gp4s-vej8 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 texas-gov/dir-sts-enterprise-invoices-gp4s-vej8: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 texas-gov/dir-sts-enterprise-invoices-gp4s-vej8: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, texas-gov/dir-sts-enterprise-invoices-gp4s-vej8 is just another Postgres schema.