.. flux-help-section: flux account

===============
flux-account(1)
===============


SYNOPSIS
========

**flux** **account** [*COMMAND*] [OPTIONS]

DESCRIPTION
===========

.. program:: flux account

:program:`flux account` provides an interface to the SQLite database containing
information regarding banks, associations, queues, projects, and archived jobs.
It also provides administrative commands like exporting and populating the DB's
information to and from ``.csv`` files, updating the database when new versions
of flux-accounting are released, and more.

DATABASE ADMINISTRATION
=======================

create-db
^^^^^^^^^

Create the flux-accounting database.

See :man1:`flux-account-create-db` for more details.

pop-db
^^^^^^

Populate a flux-accounting database with ``.csv`` files.

See :man1:`flux-account-pop-db` for more details.

export-db
^^^^^^^^^

Export a flux-accounting database into ``.csv`` files.

See :man1:`flux-account-export-db` for more details.

export-json
^^^^^^^^^^^

Export certain tables from the flux-accounting database as a JSON object to
be used when loading the multi-factor priority plugin.

See :man1:`flux-account-export-json` for more details.

USER ADMINISTRATION
===================

view-user
^^^^^^^^^

View information about an association in the flux-accounting database.

See :man1:`flux-account-view-user` for more details.

add-user
^^^^^^^^

Add an association to the flux-accounting database.

See :man1:`flux-account-add-user` for more details.

delete-user
^^^^^^^^^^^

Deactivate an association in the flux-accounting database.

See :man1:`flux-account-delete-user` for more details.

edit-user
^^^^^^^^^

Modify an attribute for an association in the flux-accounting database.

See :man1:`flux-account-edit-user` for more details.

edit-all-users
^^^^^^^^^^^^^^

Modify an attribute for every association in the flux-accounting database.

See :man1:`flux-account-edit-all-users` for more details.

BANK ADMINISTRATION
===================

view-bank
^^^^^^^^^

View information about a bank in the flux-accounting database.

See :man1:`flux-account-view-bank` for more details.

add-bank
^^^^^^^^

Add a bank to the flux-accounting database.

See :man1:`flux-account-add-bank` for more details.

delete-bank
^^^^^^^^^^^

Deactivate a bank in the flux-accounting database.

See :man1:`flux-account-delete-bank` for more details.

edit-bank
^^^^^^^^^

Modify an attribute for a bank in the flux-accounting database,

See :man1:`flux-account-edit-bank` for more details.

list-banks
^^^^^^^^^^

List all of the banks in the ``bank_table``.

See :man1:`flux-account-list-banks` for more details.

QUEUE ADMINISTRATION
====================

view-queue
^^^^^^^^^^

View information about a queue in the flux-accounting database.

See :man1:`flux-account-view-queue` for more details.

add-queue
^^^^^^^^^

Add a queue to the flux-accounting database.

See :man1:`flux-account-add-queue` for more details.

delete-queue
^^^^^^^^^^^^

Remove a queue from the flux-accounting database.

See :man1:`flux-account-delete-queue` for more details.

edit-queue
^^^^^^^^^^

Edit a queue's properties in the flux-accounting database.

See :man1:`flux-account-edit-queue` for more details.

list-queues
^^^^^^^^^^^

List all defined queues in the flux-accounting database.

See :man1:`flux-account-list-queues` for more details.

PROJECT ADMINISTRATION
======================

view-project
^^^^^^^^^^^^

View information about a project in the flux-accounting database.

See :man1:`flux-account-view-project` for more details.

add-project
^^^^^^^^^^^

Add a project to the flux-accounting database.

See :man1:`flux-account-add-project` for more details.

delete-project
^^^^^^^^^^^^^^

Remove a project from the flux-accounting database.

See :man1:`flux-account-delete-project` for more details.

list-projects
^^^^^^^^^^^^^

List all defined projects in the flux-accounting database.

See :man1:`flux-account-list-projects` for more details.

JOB RECORDS
===========

view-job-records
^^^^^^^^^^^^^^^^

View job records.

See :man1:`flux-account-view-job-records` for more details.

update-usage
^^^^^^^^^^^^

scrub-old-jobs
^^^^^^^^^^^^^^

JOB PRIORITY CONFIGURATION
==========================

view-factor
^^^^^^^^^^^

View the configured integer weight for a given priority factor.

See :man1:`flux-account-view-factor` for more details.

edit-factor
^^^^^^^^^^^

Edit the configured integer weight for a given priority factor.

See :man1:`flux-account-edit-factor` for more details.

list-factors
^^^^^^^^^^^^

List all of the priority factors and their weights.

See :man1:`flux-account-list-factors` for more details.

reset-factors
^^^^^^^^^^^^^

Reset all of the priority factors to their default weights.

See :man1:`flux-account-reset-factors` for more details.

jobs
^^^^

View a breakdown of an association's job priorities.

See :man1:`flux-account-jobs` for more details.

DATA VISUALIZATION
==================

show-usage
^^^^^^^^^^

Display a chart of the top associations or banks in terms of job usage.

See :man1:`flux-account-show-usage` for more details.