type_bridge.reserved_words

reserved_words

TypeQL reserved words and keywords.

This module contains all TypeQL reserved words that cannot be used as type names, attribute names, or role names in TypeDB schemas.

Based on TypeDB 3.x TypeQL reference documentation.

get_reserved_words

get_reserved_words()

Get the complete set of TypeQL reserved words.

Returns:

Type	Description
frozenset[str]	A frozenset of all TypeQL reserved words

Source code in type_bridge/reserved_words.py

def get_reserved_words() -> frozenset[str]:
    """Get the complete set of TypeQL reserved words.

    Returns:
        A frozenset of all TypeQL reserved words
    """
    return TYPEQL_RESERVED_WORDS

is_reserved_word

is_reserved_word(name)

Check if a name is a TypeQL reserved word.

Parameters:

Name	Type	Description	Default
name	str	The name to check	required

Returns:

Type	Description
bool	True if the name is a reserved word (case-insensitive)

Source code in type_bridge/reserved_words.py

def is_reserved_word(name: str) -> bool:
    """Check if a name is a TypeQL reserved word.

    Args:
        name: The name to check

    Returns:
        True if the name is a reserved word (case-insensitive)
    """
    return name.lower() in TYPEQL_RESERVED_WORDS