Skip to content

Commit 7f8fcef

Browse files
committed
Add a message about upgrading old databases
1 parent b78faa4 commit 7f8fcef

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ You can analyze a database by running the following command::
3636

3737
codeql database analyze <database> --format=<format> --output=<output> <queries>
3838

39+
3940
You must specify:
4041

4142
- ``<database>``: the path to the CodeQL database you want to analyze.
@@ -79,6 +80,21 @@ You can also specify:
7980

8081
- .. include:: ../reusables/threads-query-execution.rst
8182

83+
. pull-quote::
84+
85+
Upgrading databases
86+
87+
For databases that were creaated by CodeQL CLI v2.3.3 or earlier, you will need
88+
to explicitly upgrade the database before you can run an analysis with a newer
89+
version of the CodeQL CLI. If this step is necessary, then you will see a message telling you
90+
that your database needs to be upgraded when you run ``database analyze``.
91+
92+
CodeQL databases are upgraded by running the following command::
93+
94+
codeql database upgrade <database>
95+
96+
For full details of all the options you can use when upgrading databases,
97+
see the "`database upgrade <../manual/database-upgrade>`__" reference documentation.
8298

8399
For full details of all the options you can use when analyzing databases, see
84100
the `database analyze reference documentation <../manual/database-analyze>`__.

0 commit comments

Comments
 (0)