Skip to content

BigInt GA: update docs #17987

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
d10c merged 2 commits into from
Nov 20, 2024
Merged

BigInt GA: update docs #17987

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54e7db2
BigInt GA: s/arbitrary-precision/arbitrary-range/g in .rst docs
d10c Nov 14, 2024
2da1d6a
BigInt GA: remove mention of experimental status from .rst docs
d10c Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
BigInt GA: remove mention of experimental status from .rst docs
  • Loading branch information
@d10c
d10c committed Nov 19, 2024
commit 2da1d6aaa8aa2fa67e640e7e7627c33aee4f70ae
7 changes: 3 additions & 4 deletions docs/codeql/ql-language-reference/modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,10 +431,7 @@ The above query therefore evalutes to:
BigInt
======

The built-in ``QlBuiltins`` module provides an **experimental** type ``BigInt`` of arbitrary-range integers.

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. Consequently, BigInts are currently disallowed in query results and dbscheme columns.
The built-in ``QlBuiltins`` module provides a type ``BigInt`` of arbitrary-range integers.

Unlike ``int`` and ``float``, there is no automatic conversion between ``BigInt`` and other numeric types.
Instead, big integers can be constructed using the ``.toBigInt()`` methods of ``int`` and ``string``.
Expand All @@ -451,3 +448,5 @@ The other built-in operations are:
``rank``, ``unique``, ``any``.
* other: ``.pow(int)``, ``.abs()``, ``.gcd(BigInt)``, ``.minimum(BigInt)``,
``.maximum(BigInt)``.

Note: big integers are currently disallowed in query results and dbscheme columns.
2 changes: 1 addition & 1 deletion docs/codeql/ql-language-reference/types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ independent of the database that you are querying.
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
section on `built-ins <https://codeql.github.com/docs/ql-language-reference/ql-language-specification/#built-ins>`__ in the QL language specification.

Additionally, there is an experimental arbitrary-range 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.
Additionally, there is an arbitrary-range integer primitive type at :ref:`QlBuiltins::BigInt <bigint>`.

.. index:: class
.. _classes:
Expand Down
Loading