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 ley_de_cuotas
table in this repository, by referencing it like:
"datos-gov-co/ley-de-cuotas-4g2p-m8b5:latest"."ley_de_cuotas"
or in a full query, like:
SELECT
":id", -- Socrata column ID
"orden", -- Campo de acción de la administración pública de acuerdo con el ordenamiento territorial: nacional o territorial.
"clasificaci_n_org_nica", -- Estructura general de las entidades y organismos del poder público en Colombia: Ramas del poder público, órganos de control, órganos autónomos, órganos electorales y SIVJRNR.
"suborden", -- Clasificación según la división general del territorio: departamentos, municipios, distritos, regiones, provincias, áreas metropolitanas, asociaciones de municipios y territorios indígenas.
"nombre_de_la_entidad", -- Denominación verbal dada a una Entidad.
"a_o", -- Datos del tiempo que aplica la información
"idmunicipio", -- Número único de identificación y codificación de los municipios establecidos por el DANE
"c_digo_sigep", -- Índice único de identificación de la Entidad.
"nit", -- Número de Identificación tributaria de la Entidad.
"id_departamento", -- Número único de identificación y codificación de los departamentos establecidos por el DANE.
"cantidad_de_cargos_provistos_1", -- Número total de cargos provistos de los otros niveles decisorios
"cantidad_de_cargos_provistos", -- Número total de cargos provistos del máximo nivel decisorio
"cantidad_de_hombres_en_cargos_1", -- Número de hombres ocupando cargos de otros niveles decisorios
"fuente", -- Fecha de corte de obtención de la información
"latitud", -- Ángulo entre el plano ecuatorial y la línea que pasa por este punto y el centro de la Tierra
"longitud", -- Ángulo entre el meridiano de referencia y el meridiano que pasa por este punto de referencia
"naturaleza_jur_dica", -- Definición legal del organismo o entidad según su actividad o ubicación en la estructura del Estado.
"tipo_de_vinculaci_n", -- Tipo de relación jurídica de la entidad del sector descentralizado con respecto a la entidad u organismo cabeza de sector administrativo de la Rama Ejecutiva del poder público según su tipología o actividad: adscrita o vinculada.
"sector", -- El Sector Administrativo está integrado por el Ministerio o Departamento Administrativo, las superintendencias y demás entidades que la ley o el Gobierno Nacional definan como adscritas o vinculadas a aquéllos según correspondiere a cada área.
"municipio", -- Segundo nivel de división administrativa en Colombia, De acuerdo con el Artículo 311 de Constitución de 1991 y la Ley 136 de 2 de junio de 1994.
"cantidad_de_hombres_en_cargos", -- Número de hombres ocupando cargos de máximo nivel decisorio
"departamento", -- División administrativa y política según lo establece la Constitución política de 1991, 33 divisiones, 32 departamentos
"cantidad_de_mujeres_en_cargos_1", -- Número de mujeres ocupando cargos de otros niveles decisorios
"cantidad_de_mujeres_en_cargos", -- Número de mujeres ocupando cargos de máximo nivel decisorio
"nivel" -- Clasificación de las entidades y organismos que integran la Rama Ejecutiva del poder público según la tipología del artículo 38 de la ley 489 de 1998: central o descentralizado.
FROM
"datos-gov-co/ley-de-cuotas-4g2p-m8b5:latest"."ley_de_cuotas"
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/ley-de-cuotas-4g2p-m8b5
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/ley-de-cuotas-4g2p-m8b5: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; sgr
can 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 clone
and 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/ley-de-cuotas-4g2p-m8b5" \
--handler-options '{
"domain": "www.datos.gov.co",
"tables": {
"ley_de_cuotas": "4g2p-m8b5"
}
}'
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/ley-de-cuotas-4g2p-m8b5
is just another Postgres schema.