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 tabla_de_retencin_documental table in this repository, by referencing it like:
"datos-gov-co/tabla-de-retencin-documental-id2r-y7wh:latest"."tabla_de_retencin_documental"or in a full query, like:
SELECT
":id", -- Socrata column ID
"disposici_n_final_s", -- Selección es el proceso que se realiza en el Archivo Central una vez cumplido su tiempo de retención, en el cual debe estar presente un representante de la oficina a la cual se esté realizando la selección, con el fin de seleccionar aquellas unidades que ameriten ser conservadas o preservadas totalmente.
"procedimiento", -- Es el procedimiento que se deberá llevar a cabo una vez cumplido el tiempo de retención documental y asignada la disposición final de los documentos.
"soporte_del_documento_electr", -- Información que inicia y finaliza su trámite en un medio electrónico, el cual no requiere ser impreso.
"c_digo_dependencia", -- Son los códigos asignados para identificación de la dependencia, serie y subserie documental, los cuales debe corresponder con el cuadro de clasificación documental.
"oficina_productora", -- Se diligencia el nombre de la oficina o dependencia, tal y como se encuentra en la resolución 3782 del 16 de marzo de 2020.
"disposici_n_final_ct", -- Conservación Total es el proceso que se realiza a las series o subseries que dada su función requieren ser conservados y preservados como fuente de historia.
"subserie", -- Nombre de la subserie a la cual pertenece el documento según la Tabla de Retención Documental correspondiente.
"soporte_del_documento_f_sico", -- Registro de información en medio físico (papel), ya sea un documento original o una copia de acuerdo con el trámite.
"tipo", -- Nombre del documento o documentos que contiene el expediente
"disposici_n_final_mt", -- Medio Tecnológico es el proceso por el cual deben pasar los documentos que requieren ser preservados a largo plazo, de acuerdo con las tecnologías existentes se escogerá la que cumplan con los requisitos para garantizar la preservación de esta información.
"serie", -- Nombre de la serie a la cual pertenece el documento según la Tabla de Retención Documental correspondiente.
"disposici_n_final_e", -- Eliminación es el proceso que se realiza a los documentos que han perdido sus valores para la entidad, previa aprobación del comité institucional de Gestión y Desempeño.
"tiempo_de_retenci_n_archivo_1", -- Tiempo establecido una vez recibidos de los Archivos de Gestión para la conservación y preservación de los documentos, antes de su disposición final.
"soporte_del_documento_digital", -- Documento que inicio su proceso o tramite en medio físico y por agilidad en los tramites paso a ser escaneado y convertirse en digital.
"tiempo_de_retenci_n_archivo", -- Tiempo dado en años para la conservación y preservación de los documentos en el archivo en el cual iniciaron su trámite, antes de ser transferidos al Archivo Central
"series_subseries_y" -- De acuerdo con el cuadro de clasificación documental y con las mesas de trabajo se conformaron las series, subseries y sus correspondientes tipos documentales de conformidad con las funciones y trámites establecidos
FROM
"datos-gov-co/tabla-de-retencin-documental-id2r-y7wh:latest"."tabla_de_retencin_documental"
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 datos-gov-co/tabla-de-retencin-documental-id2r-y7wh 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 datos-gov-co/tabla-de-retencin-documental-id2r-y7wh: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 datos-gov-co/tabla-de-retencin-documental-id2r-y7whCheckout 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 datos-gov-co/tabla-de-retencin-documental-id2r-y7wh:latestThis will download all the objects for the latest tag of datos-gov-co/tabla-de-retencin-documental-id2r-y7wh 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 datos-gov-co/tabla-de-retencin-documental-id2r-y7wh: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 datos-gov-co/tabla-de-retencin-documental-id2r-y7wh: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, datos-gov-co/tabla-de-retencin-documental-id2r-y7wh is just another Postgres schema.