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 activos_de_informacin_de_colombia table in this repository, by referencing it like:
"datos-gov-co/activos-de-informacin-de-colombia-5cng-ebxj:latest"."activos_de_informacin_de_colombia"or in a full query, like:
SELECT
":id", -- Socrata column ID
"id", -- Identificar del Activo de Información
"datospersonales", -- Contiene o no datos personales
"titulo_informacion",
"url", -- Indica si la información esta publicada para consulta
"fechacreacion", -- Fecha en la cual se creo el registro en el sistema
"disponible", -- Indica esta disponible para consulta
"fundamentoconstitucional", -- Argumentación o justificación de la clasificación o reserva de la información
"calificacion", -- Información pública, pública clasificada, pública reservada
"integridad", -- Nivel de exactitud y completitud requerido de la información
"disponibilidad", -- Nivel de accesibilidad y usabilidad requerido de la información
"tipodatopersonal", -- Los datos personales registrados en el activo son públicos, semiprivados, privados o sensibles
"fechageneracion", -- Identifica el momento de creación de la información
"fundamento", -- Fundamento constitucional o legal que justifica la clasificación o la reserva, señalando expresamente la norma, artículo, inciso o párrafo que la a ampara
"tipoexcepcion", -- Indica si la totalidad del documento es clasificado o reservado o si solo una parte corresponde a esta calificación
"entidad", -- Nombre de la entidad propietaria del Activo de Información
"electronico", -- Define si el activo se encuentra almacenado en un medio electrónico
"descripcion", -- Breve descripción del contenido de la información
"subcategoria", -- Término o subserie con el que se da a conocer el nombre o asunto de la información
"categoria", -- Categoría o serie a la cual pertenece el activo
"publicada", -- Indica si la información esta disponible para consulta
"frecuenciaactualizacion", -- Señala la periodicidad en que el documento es actualizado
"criticidad", -- Nivel de importancia del activo para preservar su seguridad
"fundamentojuridico", -- Indicar si la totalidad del documento es clasificado o reservado o si solo una parte corresponde a esta calificación
"fechaactualizacion", -- Fecha en la cual se produjo la última actualización en el sistema
"activo", -- Define si el activo de información se encuentra activo o no
"idioma", -- Idioma en que se encuentra la información
"lengua", -- Lengua en que se encuentra la información
"fisico", -- Define si el activo se encuentra almacenado físico
"formato", -- Forma o modo en la que se presenta la información
"fechacalificacion", -- Fecha en la cual se determina el carácter de reserva o clasificación
"lugar", -- Lugar para consulta o solicitud de la información
"responsableinformacion", -- Nombre del área, dependencia o unidad interna que creo la información
"responsablecustodia", -- Nombre del área, dependencia o unidad interna que custodia o controla el acceso a la información
"objetivoexcepcion", -- Identificacion de la excepcion dentro de los literales de los articulos 18 y 19 de la Ley 1712 de 2014
"plazoclasificacion" -- Fecha en la cual dejará de estar clasificada la información
FROM
"datos-gov-co/activos-de-informacin-de-colombia-5cng-ebxj:latest"."activos_de_informacin_de_colombia"
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/activos-de-informacin-de-colombia-5cng-ebxj with SQL in under 60 seconds.
This repository is an "external" repository. That means it's hosted elsewhere, in this case at www.datos.gov.co. When you querydatos-gov-co/activos-de-informacin-de-colombia-5cng-ebxj:latest on the DDN, we "mount" the repository using the socrata mount handler. The mount handler proxies your SQL query to the upstream data source, translating it from SQL to the relevant language (in this case SoQL).
We also cache query responses on the DDN, but we run the DDN on multiple nodes so a CACHE_HIT is only guaranteed for subsequent queries that land on the same node.
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 (like this repository), 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, where the author has pushed Splitgraph Images to the repository, you can "clone" and/or "checkout" the data using sgr cloneand sgr checkout.
Mounting Data
This repository is an external repository. It's not hosted by Splitgraph. It is hosted by www.datos.gov.co, and Splitgraph indexes it. This means it is not an actual Splitgraph image, so you cannot use sgr clone to get the data. Instead, you can use the socrata adapter with the sgr mount command. Then, if you want, you can import the data and turn it into a Splitgraph image that others can clone.
First, install Splitgraph if you haven't already.
Mount the table with sgr mount
sgr mount socrata \
"datos-gov-co/activos-de-informacin-de-colombia-5cng-ebxj" \
--handler-options '{
"domain": "www.datos.gov.co",
"tables": {
"activos_de_informacin_de_colombia": "5cng-ebxj"
}
}'That's it! Now you can query the data in the mounted table like any other Postgres table.
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/activos-de-informacin-de-colombia-5cng-ebxj is just another Postgres schema.