Skip to content

Commit 6a3e34c

Browse files
authored
Merge pull request github#17987 from d10c/d10c/bigint-ga
BigInt GA: update docs
2 parents 745e52f + 2da1d6a commit 6a3e34c

File tree

3 files changed

+5
-6
lines changed

3 files changed

+5
-6
lines changed

docs/codeql/ql-language-reference/modules.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -431,10 +431,7 @@ The above query therefore evalutes to:
431431
BigInt
432432
======
433433

434-
The built-in ``QlBuiltins`` module provides an **experimental** type ``BigInt`` of arbitrary-precision integers.
435-
436-
This type is not available in the CodeQL CLI by default, but you can enable it by passing the ``--allow-experimental=bigint``
437-
option to the CodeQL CLI. Consequently, BigInts are currently disallowed in query results and dbscheme columns.
434+
The built-in ``QlBuiltins`` module provides a type ``BigInt`` of arbitrary-range integers.
438435

439436
Unlike ``int`` and ``float``, there is no automatic conversion between ``BigInt`` and other numeric types.
440437
Instead, big integers can be constructed using the ``.toBigInt()`` methods of ``int`` and ``string``.
@@ -451,3 +448,5 @@ The other built-in operations are:
451448
``rank``, ``unique``, ``any``.
452449
* other: ``.pow(int)``, ``.abs()``, ``.gcd(BigInt)``, ``.minimum(BigInt)``,
453450
``.maximum(BigInt)``.
451+
452+
Note: big integers are currently disallowed in query results and dbscheme columns.

docs/codeql/ql-language-reference/ql-language-specification.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,7 @@ An integer value is of type ``int``. Each value is a 32-bit two's complement int
445445

446446
A string is a finite sequence of 16-bit characters. The characters are interpreted as Unicode code points.
447447

448-
A :ref:`big integer <bigint>` value is of type ``QlBuiltins::BigInt``. Each value is a signed arbitrary-precision integer.
448+
A :ref:`big integer <bigint>` value is of type ``QlBuiltins::BigInt``. Each value is a signed arbitrary-range integer.
449449

450450
The database includes a number of opaque entity values. Each such value has a type that is one of the database types, and an identifying integer. An entity value is written as the name of its database type followed by its identifying integer in parentheses. For example, ``@tree(12)``, ``@person(16)``, and ``@location(38132)`` are entity values. The identifying integers are left opaque to programmers in this specification, so an implementation of QL is free to use some other set of countable labels to identify its entities.
451451

docs/codeql/ql-language-reference/types.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ independent of the database that you are querying.
5252
QL has a range of built-in operations defined on primitive types. These are available by using dispatch on expressions of the appropriate type. For example, ``1.toString()`` is the string representation of the integer constant ``1``. For a full list of built-in operations available in QL, see the
5353
section on `built-ins <https://codeql.github.com/docs/ql-language-reference/ql-language-specification/#built-ins>`__ in the QL language specification.
5454

55-
Additionally, there is an experimental arbitrary-precision integer primitive type at :ref:`QlBuiltins::BigInt <bigint>`. This type is not available in the CodeQL CLI by default, but you can enable it by passing the ``--allow-experimental=bigint`` option to the CodeQL CLI.
55+
Additionally, there is an arbitrary-range integer primitive type at :ref:`QlBuiltins::BigInt <bigint>`.
5656

5757
.. index:: class
5858
.. _classes:

0 commit comments

Comments
 (0)