Usage

Running LCCS-DB in the Command Line

If you have not installed lccs-db yet, please, take a look at the Installation Guide.

Creating a PostgreSQL Database

If you do not have a database instance, you can create one with the command line utility lccs_db:

SQLALCHEMY_DATABASE_URI="postgresql://username:password@host:5432/dbname" \
lccs-db db init

Create a schema (or namespace) named “lccs” in this database:

SQLALCHEMY_DATABASE_URI="postgresql://username:password@host:5432/dbname" \
lccs-db db create-namespaces

You can see all namespaces:

SQLALCHEMY_DATABASE_URI="postgresql://username:password@host:5432/dbname" \
lccs-db db show-namespaces

Create extension named “hstore” in this database:

SQLALCHEMY_DATABASE_URI="postgresql://username:password@host:5432/dbname" \
lccs-db db create-extension-hstore

Creating the LCCS Data Model

The command line utility lccs_db can also be used to create all tables belonging to the LCCS data model. The following command can be used to create or upgrade the table schema for LCCS:

SQLALCHEMY_DATABASE_URI="postgresql://username:password@host:5432/dbname" \
lccs-db alembic upgrade

If the above command succeed, you can check the created tables within the lccs schema in PostgreSQL. Use the psql terminal as follow:

psql -U username -h host -p 5432 -d dbname -c "\dt lccs.*"

You should get a similar output:

                  List of relations
 Schema |           Name           | Type  |  Owner
--------+--------------------------+-------+----------
 lccs   | class_mappings           | table | postgres
 lccs   | classes                  | table | postgres
 lccs   | classification_systemSRC | table | postgres
 lccs   | classification_systems   | table | postgres
 lccs   | style_formats            | table | postgres
 lccs   | styles                   | table | postgres
 lccs   | transition_classes       | table | postgres
(7 rows)

Loading Default Class Systems

You can load well-known classification systems with the CLI:

SQLALCHEMY_DATABASE_URI="postgresql://username:password@host:5432/dbname" \
lccs-db db load-scripts

Loading Custom Class Systems

You can load your own classification systems with the CLI:

SQLALCHEMY_DATABASE_URI="postgresql://username:password@host:5432/dbname" \
lccs-db db load-file --file "sql_file.sql"

Loading Style for Classification System

You can load your style file with the CLI:

SQLALCHEMY_DATABASE_URI="postgresql://username:password@host:5432/dbname" \
lccs_db lccs insert-style --system_name PRODES \
--style_format_name QML-Feature-Polygon \
--system_version 1.0 \
--file /path/to/style/style_name.qml

Note

For more information on lccs_db commands, please, type in the command line:

lccs-db  --help