Add and reference data in ARLAS

ARLAS-server interfaces with data indexed in Elasticsearch via a collection reference

Collection model

The collection references an identifier, a timestamp, and geographical fields which allows ARLAS-server to perform a spatial-temporal data analysis.

In addition to these fields referencers, you can add metadata describing your data in the collection using

  • ATOM Description
  • Dublin Core Description

Go further

Get more details about the collection model in this section

Referencing data

  1. Start an ARLAS-server instance. If you're new to ARLAS, you can easily start an instance following the Quick Start instructions
  2. Register your Elasticsearch index within ARLAS Exploration:

With script

Launch the script

cd ARLAS-Exploration-stack
./collections/ [--arlas-server-url] [--name] [--index] [--id_path] [--centroid_path] [--geometry_path] [--timestamp_path]


This script allows you to create a basic collection reference where you define the identifier, timestamp, and geographical fields of your indexed data. If you want to define a more sophisticated collection with metadata, please use the collection API of ARLAS-server.

With collection API of ARLAS-server

Use the PUT ${ARLAS_SERVER_URL}/collections/${COLLECTION_NAME} endpoint to create a collection

curl -X PUT \
--header 'Content-Type: application/json;charset=utf-8' \
--header 'Accept: application/json' \
--data @collection.json

where collection.json is the collection model given to PUT collection endpoint


See the collection API documentation for further help on how to manage your ARLAS Collections.