CLI reference
The CLI is implementated with click and automaticaly documented with mkdocs-click.
Usage:
docker exec app COMMAND
Available commands
baa
This is the main entrypoint for the BAA CLI.
Usage:
baa [OPTIONS] COMMAND [ARGS]...
Options:
-v, --verbose Output more to the log
-q, --enable-query-log Enables logging of DB queries
-t, --time Output the duration of the command
-p, --profile Turn on the python profiler
-w, --worker Spawn a worker (if not already running)
--celery-interval INTEGER Celery polling interval
--help Show this message and exit.
baa auth
Commands regarding creating and updating users
Usage:
baa auth [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
baa auth create-user
Create a new user
Usage:
baa auth create-user [OPTIONS]
Options:
-n, --name TEXT The name of the user
-e, --email TEXT The email of the user
-p, --password TEXT The password of the user
--help Show this message and exit.
baa capacity
All commands regarding the Azure Fabric Capacity.
Usage:
baa capacity [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
baa capacity scale
Scale (up/down) to the specified SKU.
Usage:
baa capacity scale [OPTIONS] {F2|F4|F8|F16|F32|F64}
Options:
--help Show this message and exit.
baa capacity start
Start the capacity if it's not running.
Usage:
baa capacity start [OPTIONS]
Options:
--async Do not wait for the capacity to be started
--help Show this message and exit.
baa capacity status
Usage:
baa capacity status [OPTIONS]
Options:
--help Show this message and exit.
baa capacity stop
Stop the capacity if it's running.
Usage:
baa capacity stop [OPTIONS]
Options:
--help Show this message and exit.
baa capacity stop-if-idle
Stop the capacity if it's running but hasn't been used for 15 minutes.
Usage:
baa capacity stop-if-idle [OPTIONS]
Options:
--help Show this message and exit.
baa database
All commands regarding database management
Usage:
baa database [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
baa database create-pbi-user
Usage:
baa database create-pbi-user [OPTIONS]
Options:
-p, --password TEXT
--help Show this message and exit.
baa database downgrade
Reverse Alembic migration.
Shortcut for: alembic downgrade -1
Usage:
baa database downgrade [OPTIONS]
Options:
--help Show this message and exit.
baa database make-migrations
Create Alembic migration.
Shortcut for: alembic revision --autogenerate -m [MESSAGE]
Usage:
baa database make-migrations [OPTIONS] MESSAGE
Options:
--help Show this message and exit.
baa database migrate
Apply Alembic migrations.
Shortcut for: alembic upgrade head
Usage:
baa database migrate [OPTIONS]
Options:
--help Show this message and exit.
baa database remove-temp-tables
Remove all temp_* tables
Usage:
baa database remove-temp-tables [OPTIONS]
Options:
--help Show this message and exit.
baa database update-partition-column
Usage:
baa database update-partition-column [OPTIONS] ENTITY
Options:
--help Show this message and exit.
baa dispatch-task
Usage:
baa dispatch-task [OPTIONS] CMD [ARGS]...
Options:
-s, --sync Execute sync
--help Show this message and exit.
baa exact
Commands regarding the Exact Online integration
Usage:
baa exact [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
baa exact connect-rgs
Usage:
baa exact connect-rgs [OPTIONS]
Options:
--help Show this message and exit.
baa exact detect-schema
Automatically detect the schemas of entities defined in the Exact config
Usage:
baa exact detect-schema [OPTIONS]
Options:
--help Show this message and exit.
baa exact entity-count
Usage:
baa exact entity-count [OPTIONS]
Options:
-d, --division INTEGER The division to get the count for
[required]
-e, --entity [BankEntries|Divisions|FinancialPeriods|GLAccountClassificationMappings|GLAccounts|GLClassifications|GLTransactionTypes|GLSchemes|OutstandingInvoicesOverview|Payables|ProfitLossOverview|Receivables|RevenueList|TransactionLines|AgingOverview|AgingReceivables|AgingPayables|Budgets|Journals|JournalStatus]
The entity to get the count for [required]
--help Show this message and exit.
baa exact fetch-data
Fetch all data from the Exact Online API
Usage:
baa exact fetch-data [OPTIONS]
Options:
-d, --division INTEGER The division to fetch data for, if omitted
all divisions are fetched
-e, --entities [BankEntries|Divisions|FinancialPeriods|GLAccountClassificationMappings|GLAccounts|GLClassifications|GLTransactionTypes|GLSchemes|OutstandingInvoicesOverview|Payables|ProfitLossOverview|Receivables|RevenueList|TransactionLines|AgingOverview|AgingReceivables|AgingPayables|Budgets|Journals|JournalStatus]
The entities to fetch, if omitted everything
is fetched
-r, --refresh-pbi Refreshes the Power BI dataset if changes
are detected
-s, --capacity-scale [F2|F4|F8|F16|F32|F64]
Scale the capacity before a PowerBI refresh,
the capacity will scale down when finished
-c, --constants Also fetch constants
-f, --force Force fetch all data (by removing the
incremental fetch record)
-x, --existing-only Only fetches divisions we have fetched
before
-n, --new-only Only fetches divisions we have not fetched
before
-l, --limit INTEGER Fetch a limited number of divisions
--help Show this message and exit.
baa exact push-rgs
Usage:
baa exact push-rgs [OPTIONS]
Options:
-d, --division INTEGER
--help Show this message and exit.
baa exact refresh-tokens
Refresh all tokens for the Exact Online API
Usage:
baa exact refresh-tokens [OPTIONS]
Options:
--help Show this message and exit.
baa exact update-balances
Usage:
baa exact update-balances [OPTIONS]
Options:
-d, --division INTEGER The division to update balances for, if omitted all
divisions are updated
-f, --force Force update by removing current aggregates
--help Show this message and exit.
baa fetch-process-progress
Usage:
baa fetch-process-progress [OPTIONS] ID
Options:
--help Show this message and exit.
baa mail
Commands regarding sending mails
Usage:
baa mail [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
baa mail confirm-email
Usage:
baa mail confirm-email [OPTIONS]
Options:
--help Show this message and exit.
baa mail test
Test email sending
Usage:
baa mail test [OPTIONS] EMAIL_ADDRESS NAME
Options:
--help Show this message and exit.
baa nmbrs
Commands regarding the NMBRS integration
Usage:
baa nmbrs [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
baa nmbrs aggregate
Usage:
baa nmbrs aggregate [OPTIONS]
Options:
-c, --company INTEGER The company to update aggregate for, if omitted all
companies are updated
-f, --force Force update by removing current aggregates
--help Show this message and exit.
baa nmbrs detect-schema
Automatically detect the schemas of entities defined in the NMBRSconfig
Usage:
baa nmbrs detect-schema [OPTIONS]
Options:
-f, --force Replace existing schema declarations
--help Show this message and exit.
baa nmbrs fetch-data
Fetch all data from the NMBRS API
Usage:
baa nmbrs fetch-data [OPTIONS]
Options:
-f, --force Ignore incremental fetch and refetch all
--help Show this message and exit.
baa nmbrs generate-period-table
Generate a table with NMBRS periods
Usage:
baa nmbrs generate-period-table [OPTIONS]
Options:
--help Show this message and exit.
baa nmbrs refresh-tokens
Refresh all tokens for the NMBRS API
Usage:
baa nmbrs refresh-tokens [OPTIONS]
Options:
--help Show this message and exit.
baa powerbi
Commands regarding PowerBI
Usage:
baa powerbi [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
baa powerbi cancel-refresh
Cancel a PBi refresh that is currently running
Usage:
baa powerbi cancel-refresh [OPTIONS] REFRESH_ID
Options:
--help Show this message and exit.
baa powerbi clear-table
Usage:
baa powerbi clear-table [OPTIONS] TABLE_NAME
Options:
--help Show this message and exit.
baa powerbi objects-due-to-refresh
Usage:
baa powerbi objects-due-to-refresh [OPTIONS]
Options:
--help Show this message and exit.
baa powerbi progress
Get the progress of the last Power BI refresh. This could also be a refresh initiated from app.powerbi.com.
Usage:
baa powerbi progress [OPTIONS] [ID]
Options:
--help Show this message and exit.
baa powerbi refresh
Refresh PowerBI tables
Usage:
baa powerbi refresh [OPTIONS] [TABLES]...
Options:
-f, --full Starts a full refresh, ignoring incremental
refresh policies
-q, --queue Queue the refresh instead of processing it
right away
-s, --capacity-scale [F2|F4|F8|F16|F32|F64]
Scale the capacity before executing the
refresh, the capacity will scale down when
finished
--help Show this message and exit.
baa powerbi xmla
XMLA commands
Usage:
baa powerbi xmla [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
baa powerbi xmla deploy
Deploy the .bim file to Power BI Service. Partitions are added to all tables.
Usage:
baa powerbi xmla deploy [OPTIONS]
Options:
--help Show this message and exit.
baa powerbi xmla list-tables
List all tables and partitions inside the local .bim file or inside the dataset in Power BI Service.
Usage:
baa powerbi xmla list-tables [OPTIONS]
Options:
-b, --bim Read from the local .bim file instead of
from the server
-s, --save Save table/partition combinations to the
database
-n, --need-refresh Only list tables that need to be refreshed
-r, --refresh Refresh tables that need to be refreshed
--capacity-scale [F2|F4|F8|F16|F32|F64]
Scale the capacity before executing the
refresh, the capacity will scale down when
finished
--help Show this message and exit.
baa test
Test the system and environment
Usage:
baa test [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
baa test axiom
Usage:
baa test axiom [OPTIONS]
Options:
--help Show this message and exit.
baa test celery
Usage:
baa test celery [OPTIONS]
Options:
--help Show this message and exit.
baa test database
Usage:
baa test database [OPTIONS]
Options:
--help Show this message and exit.
baa test db-storage
Usage:
baa test db-storage [OPTIONS]
Options:
-f, --file TEXT The filename of the test file
--help Show this message and exit.
baa test refresh-pbi
Usage:
baa test refresh-pbi [OPTIONS]
Options:
--help Show this message and exit.