Skip to content

Commit d34bcdc

Browse files
committed
[#3426] updated docs about extended-info4/6-upgrade commands
1 parent ed6a007 commit d34bcdc

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

doc/sphinx/arm/hooks-lease-query.rst

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -613,6 +613,12 @@ backends, leases created prior to the server being configured for bulk lease
613613
query do not contain the new data required. In order to populate this data,
614614
it is necessary to run these API commands:
615615

616+
.. note::
617+
618+
Existing leases must have been created by Kea with ``store-extended-info``
619+
enabled, in order for the new data from extended info to be extracted
620+
and stored.
621+
616622
.. isccmd:: extended-info4-upgrade
617623
.. _command-extended-info4-upgrade:
618624

@@ -651,7 +657,8 @@ and includes either the count of leases updated or the nature of the failure:
651657

652658
This ``extended-info6-upgrade`` command must be called when:
653659

654-
- the database schema was upgraded from a previous version.
660+
- the database schema was upgraded from 2.4.1 or older version.
661+
``extended-info4-upgrade`` can be used when upgrading from 2.3.8 or older version.
655662

656663
- Bulk Leasequery was not enabled; tables are maintained only when v6 BLQ is
657664
enabled.
@@ -668,7 +675,7 @@ For large numbers of leases, this command may take some time to complete.
668675

669676
.. note::
670677

671-
Existing leases must have been created by Kea with ``store-extended-info``
672-
enabled, in order for the new data from extended info to be extracted
673-
and stored.
674-
678+
Both the ``extended-info4-upgrade`` and ``extended-info6-upgrade`` commands
679+
are intended for one-time use after upgrading to a version of Kea that fully
680+
supports Bulk Leasequery in database backends. These commands are not meant
681+
for regular use and will be removed in future Kea versions.

0 commit comments

Comments
 (0)