.. index::
   single: ebas_delete; program

.. program:: ebas_delete

.. _EBASprogram_ebas_delete:

ebas_delete
===========

The program *ebas_delete* deletes data from the EBAS database.

For regular dataset, the deletion is not permanent, but the data are marked as
deleted with the time of deletion. Thus any historic state of the database can be
reproduced at a later point in time (see also :ref:`EbasHistory`).

NRT data are permanently deleted without leaving any historic information.

Synopsis
--------

::

   ebas_delete.py [-h] [--version] [--cfgfile CFGFILE]
                  [--loglevconsole LOGLEVCONSOLE]
                  [--loglevfile LOGLEVFILE] [--logfile LOGFILE]
                  [--profile] [--nodb] [--dbHost DBHOST] [--db DB]
                  [--dbUser DBUSER] [--dbPasswd DBPASSWD]
                  [--transcomment COMMENT] [--nowrite] [--nocommit]
                  [--do_id DO_ID] [--setkey SETKEY]
                  [--station STATION] [--project PROJECT]
                  [--instrument INSTRUMENT] [--component COMPONENT]
                  [--matrix MATRIX] [--group GROUP] [--fi_ref FI_REF]
                  [--me_ref ME_REF] [--resolution RESOLUTION]
                  [--statistics STATISTICS] [--time TIME]
                  [--non-interactive]


Commandline arguments
---------------------

.. include:: ./include/commandline_arguments/intro.include

General arguments
^^^^^^^^^^^^^^^^^

.. include:: ./include/commandline_arguments/general.include


Configuration arguments
^^^^^^^^^^^^^^^^^^^^^^^

.. include:: include/commandline_arguments/config.include


Logging arguments
^^^^^^^^^^^^^^^^^

.. include:: include/commandline_arguments/logging.include


Database arguments
^^^^^^^^^^^^^^^^^^

.. include:: include/commandline_arguments/db.include

.. include:: include/commandline_arguments/db_transcomment.include

.. note::

   If the transaction comment is not set as a commandline argument,
   *ebas_delete* will prompt for a comment before the deletions are committed
   to the database. For *ebas_delete* a comment is obligatory (no deletions
   without reason and documentation).

.. include:: include/commandline_arguments/db_nowrite.include

.. include:: include/commandline_arguments/db_nocommit.include


Commandline arguments for dataset selection criteria
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Dataset selection criteria are used to define a set of data to be deleted
by *ebas_delete*.

.. include:: include/commandline_arguments/ds_criteria.include


Time interval criteria
^^^^^^^^^^^^^^^^^^^^^^

.. include:: include/commandline_arguments/time.include


Arguments specific to *ebas_extract*
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. option:: --non-interactive

   Disables `user interaction`_. In case the safety thresholds for user
   interaction (confirmation) are exeeded, *ebas_delete* will not perform the
   deletion and exit with an error code.

   This option is thought to be used in scripts (which can't deal with
   interactive programs). Yet, the safety feature is still in place (won't delete
   big amount of data if the script malfunctions).

.. include:: include/user_interaction.include