Skip to content

RelationalAI Private Docs

GitHub

Build
Manage
API Reference
Release Notes
Early Access

Python
- latest
  - Overview
  - agent
    
    Overview
    
    cortex
    
    Overview
    
    chat
    
    Overview
    ChatResponse class
    CortexAgentChat class
    
    cortex_agent_manager
    
    Overview
    CortexAgentManager class
    
    deployment_config
    
    Overview
    DeploymentConfig class
    DeploymentStatus class
    
    discover_imports
    
    Overview
    discover_imports func
    
    queries
    
    Overview
    Queries class
    QueryCatalog class
    
    tool
    
    Overview
    DefaultTool class
    MaturityLevel class
    Tool class
    ToolRegistry class
    
    verbalize
    
    Overview
    ModelVerbalizer class
    SourceCodeVerbalizer class
    Verbalizer class
    
    http_client func
    APIResponseError class
    CortexAgentApi class
    CortexThreadApi class
  - auth
    
    Overview
    
    handlers
    
    Overview
    
    base
    
    Overview
    DirectAccessAuthError class
    DirectAccessConfigError class
    DirectAccessEndpointStaleError class
    DirectAccessOAuthBrowserOpenError class
    DirectAccessOAuthError class
    DirectAccessOAuthInvalidClientError class
    DirectAccessOAuthStateMismatchError class
    DirectAccessOAuthTimeoutError class
  - client
    
    Overview
    
    client
    
    Overview
    Client class
    
    client_sync
    
    Overview
    ClientSync class
    
    errors
    
    Overview
    
    exceptions
    
    Overview
    AbortedTransactionError class
    ClientAuthError class
    ClientConflictError class
    ClientError class
    ClientInvalidRequestError class
    ClientNotFoundError class
    ClientNotReadyError class
    ClientServerError class
    ClientSqlCompilationError class
    ClientTimeoutError class
    ClientUnknownError class
    DuoSecurityFailed class
    SnowflakeAppMissingException class
    SnowflakeConnectionFailed class
    SnowflakeDatabaseException class
    SnowflakeRaiAppNotStarted class
    
    connect func
    connect_sync func
    from_session func
    from_session_sync func
  - config
    
    Overview
    
    config
    
    Overview
    create_config func
    Config class
    ConfigFromDBT class
    ConfigFromRAIConfigToml class
    ConfigFromSnowflake class
    RAIConfig class
    
    config_fields
    
    Overview
    CompilerConfig class
    DataConfig class
    DebugConfig class
    RetriesConfig class
    ExecutionConfig class
    JobsConfig class
    ModelConfig class
    OutputsConfig class
    
    config_reasoners_fields
    
    Overview
    AWSEngineSize attr
    AzureEngineSize attr
    EngineSize attr
    InternalEngineSize attr
    LogicReasonerConfig class
    PrescriptiveReasonerConfig class
    ReasonerConfig class
    ReasonerLogicLqpConfig class
    ReasonersConfig class
    
    connections
    
    Overview
    
    base
    
    Overview
    BaseConnection class
    
    duckdb
    
    Overview
    
    local
    
    Overview
    LocalConnection class
    
    snowflake
    
    Overview
    SnowflakeAuthenticator attr
    SnowflakeConnection attr
    ExternalBrowserAuth class
    JWTAuth class
    OAuthAuth class
    OAuthAuthorizationCodeAuth class
    ProgrammaticAccessTokenAuth class
    SnowflakeConnectionBase class
    UsernamePasswordAuth class
    UsernamePasswordMFAAuth class
    
    ConnectionConfig attr
    
    errors
    
    Overview
    
    context
    
    Overview
    ConfigErrorContext class
    ConfigSourceType class
    
    exceptions
    
    Overview
    AttemptedSource class
    ConfigError class
    ConfigFieldMissingError class
    ConfigFieldTypeError class
    ConfigFileNotFoundError class
    ConfigValidationError class
  - semantics
    
    Overview
    
    frontend
    
    Overview
    
    base
    
    Overview
    Primitive attr
    Statement attr
    StatementAndSchema attr
    Value attr
    Aggregate class
    Alias class
    AsBool class
    Chain class
    Concept class
    Data class
    DerivedColumn class
    DerivedTable class
    Distinct class
    DSLBase class
    Expression class
    Field class
    FieldRef class
    FilterBy class
    Fragment class
    Group class
    Literal class
    Match class
    Model class
    New class
    Not class
    NumberConcept class
    Property class
    Reading class
    Ref class
    Relationship class
    Table class
    TableSchema class
    TupleVariable class
    Union class
    Variable class
    
    core
    
    Overview
    Any attr
    AnyEntity attr
    Bool attr
    Boolean attr
    Date attr
    DateTime attr
    Decimal attr
    DefaultNumber attr
    Error attr
    Float attr
    Hash attr
    Int attr
    Int128 attr
    Int64 attr
    Integer attr
    Number attr
    Numeric attr
    ScaledNumber attr
    String attr
    AnyNumber class
    
    reasoners
    
    Overview
    
    graph
    
    Overview
    
    core
    
    Overview
    Graph class
    
    predictive
    
    Overview
    
    estimator
    
    Overview
    GNN class
    
    property_transformer
    
    Overview
    PropertyTransformer class
    
    prescriptive
    
    Overview
    
    problem
    
    Overview
    Problem class
    
    all_different func
    implies func
    special_ordered_set_type_1 func
    special_ordered_set_type_2 func
    
    std
    
    Overview
    
    aggregates
    
    Overview
    asc func
    avg func
    bottom func
    count func
    cumsum_asc func
    desc func
    limit func
    max func
    min func
    per func
    rank func
    rank_asc func
    rank_desc func
    string_join func
    sum func
    top func
    Per class
    
    common
    
    Overview
    cast func
    hash func
    parse_uuid func
    range func
    raw_source func
    uuid_to_string func
    
    constraints
    
    Overview
    anyof func
    exclusive func
    oneof func
    unique func
    
    datetime
    
    Overview
    DatePart attr
    DateTimePart attr
    Frequency attr
    days func
    hours func
    microseconds func
    milliseconds func
    minutes func
    months func
    nanoseconds func
    seconds func
    weeks func
    years func
    date class
    datetime class
    ISO class
    
    decimals
    
    Overview
    decimal func
    is_decimal func
    parse func
    parse_decimal func
    precision func
    scale func
    size func
    
    floats
    
    Overview
    float func
    parse_float func
    
    integers
    
    Overview
    int128 func
    int64 func
    parse func
    parse_int128 func
    parse_int64 func
    
    math
    
    Overview
    abs func
    acos func
    acosh func
    acot func
    asin func
    asinh func
    atan func
    atanh func
    cbrt func
    ceil func
    clip func
    cos func
    cosh func
    cot func
    degrees func
    erf func
    erfinv func
    exp func
    factorial func
    floor func
    haversine func
    isclose func
    isinf func
    isnan func
    log func
    log10 func
    log2 func
    maximum func
    minimum func
    natural_log func
    pow func
    radians func
    round func
    sign func
    sin func
    sinh func
    sqrt func
    tan func
    tanh func
    trunc_divide func
    
    numbers
    
    Overview
    digits_to_bits func
    integer func
    is_number func
    number func
    parse func
    parse_number func
    precision func
    scale func
    size func
    
    re
    
    Overview
    
    strings
    
    Overview
    concat func
    contains func
    endswith func
    join func
    len func
    levenshtein func
    like func
    lower func
    regex_match func
    replace func
    split func
    split_part func
    startswith func
    string func
    strip func
    substring func
    upper func
    
    DateTimeValue attr
    DateValue attr
    FloatValue attr
    IntegerValue attr
    NumberValue attr
    StringValue attr
    
    data func
    define func
    distinct func
    not_ func
    require func
    select func
    union func
    where func
  - services
    
    Overview
    
    jobs
    
    Overview
    
    client
    
    Overview
    JobsClient class
    
    client_sync
    
    Overview
    JobsClientSync class
    
    errors
    
    Overview
    JobCapabilityError class
    JobClientDisconnectedError class
    JobConfigurationError class
    JobError class
    JobInvalidRequestError class
    JobNotFoundError class
    JobNotReadyError class
    JobServerError class
    JobTimeoutError class
    JobUnknownError class
    
    reasoners
    
    Overview
    
    client
    
    Overview
    ReasonersClient class
    
    client_sync
    
    Overview
    ReasonersClientSync class
    
    errors
    
    Overview
    ReasonerAuthError class
    ReasonerConflictError class
    ReasonerError class
    ReasonerHttpError class
    ReasonerInvalidRequestError class
    ReasonerNotFoundError class
    ReasonerNotReadyError class
    ReasonerServerError class
    ReasonerTimeoutError class
    ReasonerUnknownError class
    ReasonerValidationException class
- v1.0
  - Overview
  - agent
    
    Overview
    
    cortex
    
    Overview
    
    chat
    
    Overview
    ChatResponse class
    CortexAgentChat class
    
    cortex_agent_manager
    
    Overview
    CortexAgentManager class
    
    deployment_config
    
    Overview
    DeploymentConfig class
    DeploymentStatus class
    
    discover_imports
    
    Overview
    discover_imports func
    
    queries
    
    Overview
    Queries class
    QueryCatalog class
    
    tool
    
    Overview
    DefaultTool class
    MaturityLevel class
    Tool class
    ToolRegistry class
    
    verbalize
    
    Overview
    ModelVerbalizer class
    SourceCodeVerbalizer class
    Verbalizer class
    
    http_client func
    APIResponseError class
    CortexAgentApi class
    CortexThreadApi class
  - auth
    
    Overview
    
    handlers
    
    Overview
    
    base
    
    Overview
    DirectAccessAuthError class
    DirectAccessConfigError class
    DirectAccessEndpointStaleError class
    DirectAccessOAuthBrowserOpenError class
    DirectAccessOAuthError class
    DirectAccessOAuthInvalidClientError class
    DirectAccessOAuthStateMismatchError class
    DirectAccessOAuthTimeoutError class
  - client
    
    Overview
    
    client
    
    Overview
    Client class
    
    client_sync
    
    Overview
    ClientSync class
    
    errors
    
    Overview
    
    exceptions
    
    Overview
    AbortedTransactionError class
    ClientAuthError class
    ClientConflictError class
    ClientError class
    ClientInvalidRequestError class
    ClientNotFoundError class
    ClientNotReadyError class
    ClientServerError class
    ClientSqlCompilationError class
    ClientTimeoutError class
    ClientUnknownError class
    DuoSecurityFailed class
    SnowflakeAppMissingException class
    SnowflakeConnectionFailed class
    SnowflakeDatabaseException class
    SnowflakeRaiAppNotStarted class
    
    connect func
    connect_sync func
    from_session func
    from_session_sync func
  - config
    
    Overview
    
    config
    
    Overview
    create_config func
    Config class
    ConfigFromDBT class
    ConfigFromRAIConfigToml class
    ConfigFromSnowflake class
    RAIConfig class
    
    config_fields
    
    Overview
    CompilerConfig class
    DataConfig class
    DebugConfig class
    RetriesConfig class
    ExecutionConfig class
    JobsConfig class
    ModelConfig class
    
    config_reasoners_fields
    
    Overview
    AWSEngineSize attr
    AzureEngineSize attr
    EngineSize attr
    InternalEngineSize attr
    LogicReasonerConfig class
    PrescriptiveReasonerConfig class
    ReasonerConfig class
    ReasonerLogicLqpConfig class
    ReasonersConfig class
    
    connections
    
    Overview
    
    base
    
    Overview
    BaseConnection class
    
    duckdb
    
    Overview
    DuckDBConnection class
    
    local
    
    Overview
    LocalConnection class
    
    snowflake
    
    Overview
    SnowflakeAuthenticator attr
    SnowflakeConnection attr
    ExternalBrowserAuth class
    JWTAuth class
    OAuthAuth class
    OAuthAuthorizationCodeAuth class
    ProgrammaticAccessTokenAuth class
    SnowflakeConnectionBase class
    UsernamePasswordAuth class
    UsernamePasswordMFAAuth class
    
    ConnectionConfig attr
    
    errors
    
    Overview
    
    context
    
    Overview
    ConfigErrorContext class
    ConfigSourceType class
    
    exceptions
    
    Overview
    AttemptedSource class
    ConfigError class
    ConfigFieldMissingError class
    ConfigFieldTypeError class
    ConfigFileNotFoundError class
    ConfigValidationError class
  - semantics
    
    Overview
    
    frontend
    
    Overview
    
    base
    
    Overview
    Primitive attr
    Statement attr
    StatementAndSchema attr
    Value attr
    Aggregate class
    Alias class
    AsBool class
    Chain class
    Concept class
    Data class
    DerivedColumn class
    DerivedTable class
    Distinct class
    DSLBase class
    Expression class
    Field class
    FieldRef class
    FilterBy class
    Fragment class
    Group class
    Literal class
    Match class
    Model class
    New class
    Not class
    NumberConcept class
    Property class
    Reading class
    Ref class
    Relationship class
    Table class
    TableSchema class
    TupleVariable class
    Union class
    Variable class
    
    core
    
    Overview
    Any attr
    AnyEntity attr
    Bool attr
    Boolean attr
    Date attr
    DateTime attr
    Decimal attr
    DefaultNumber attr
    Error attr
    Float attr
    Hash attr
    Int attr
    Int128 attr
    Int64 attr
    Integer attr
    Number attr
    Numeric attr
    ScaledNumber attr
    String attr
    AnyNumber class
    
    reasoners
    
    Overview
    
    graph
    
    Overview
    
    core
    
    Overview
    Graph class
    
    prescriptive
    
    Overview
    
    problem
    
    Overview
    Problem class
    
    all_different func
    implies func
    special_ordered_set_type_1 func
    special_ordered_set_type_2 func
    
    std
    
    Overview
    
    aggregates
    
    Overview
    asc func
    avg func
    bottom func
    count func
    cumsum_asc func
    desc func
    limit func
    max func
    min func
    per func
    rank func
    rank_asc func
    rank_desc func
    string_join func
    sum func
    top func
    Per class
    
    common
    
    Overview
    cast func
    hash func
    parse_uuid func
    range func
    raw_source func
    uuid_to_string func
    
    constraints
    
    Overview
    anyof func
    exclusive func
    oneof func
    unique func
    
    datetime
    
    Overview
    DatePart attr
    DateTimePart attr
    Frequency attr
    days func
    hours func
    microseconds func
    milliseconds func
    minutes func
    months func
    nanoseconds func
    seconds func
    weeks func
    years func
    date class
    datetime class
    ISO class
    
    decimals
    
    Overview
    decimal func
    is_decimal func
    parse func
    parse_decimal func
    precision func
    scale func
    size func
    
    floats
    
    Overview
    float func
    parse_float func
    
    integers
    
    Overview
    int128 func
    int64 func
    parse func
    parse_int128 func
    parse_int64 func
    
    math
    
    Overview
    abs func
    acos func
    acosh func
    acot func
    asin func
    asinh func
    atan func
    atanh func
    cbrt func
    ceil func
    clip func
    cos func
    cosh func
    cot func
    degrees func
    erf func
    erfinv func
    exp func
    factorial func
    floor func
    haversine func
    isclose func
    isinf func
    isnan func
    log func
    log10 func
    log2 func
    maximum func
    minimum func
    natural_log func
    pow func
    radians func
    round func
    sign func
    sin func
    sinh func
    sqrt func
    tan func
    tanh func
    trunc_divide func
    
    numbers
    
    Overview
    digits_to_bits func
    integer func
    is_number func
    number func
    parse func
    parse_number func
    precision func
    scale func
    size func
    
    re
    
    Overview
    
    strings
    
    Overview
    concat func
    contains func
    endswith func
    join func
    len func
    levenshtein func
    like func
    lower func
    regex_match func
    replace func
    split func
    split_part func
    startswith func
    string func
    strip func
    substring func
    upper func
    
    DateTimeValue attr
    DateValue attr
    FloatValue attr
    IntegerValue attr
    NumberValue attr
    StringValue attr
    
    data func
    define func
    distinct func
    not_ func
    require func
    select func
    union func
    where func
  - services
    
    Overview
    
    jobs
    
    Overview
    
    client
    
    Overview
    JobsClient class
    
    client_sync
    
    Overview
    JobsClientSync class
    
    errors
    
    Overview
    JobCapabilityError class
    JobClientDisconnectedError class
    JobConfigurationError class
    JobError class
    JobInvalidRequestError class
    JobNotFoundError class
    JobNotReadyError class
    JobServerError class
    JobTimeoutError class
    JobUnknownError class
    
    reasoners
    
    Overview
    
    client
    
    Overview
    ReasonersClient class
    
    client_sync
    
    Overview
    ReasonersClientSync class
    
    errors
    
    Overview
    ReasonerAuthError class
    ReasonerConflictError class
    ReasonerError class
    ReasonerHttpError class
    ReasonerInvalidRequestError class
    ReasonerNotFoundError class
    ReasonerNotReadyError class
    ReasonerServerError class
    ReasonerTimeoutError class
    ReasonerUnknownError class
    ReasonerValidationException class
- v1.1
  - Overview
  - agent
    
    Overview
    
    cortex
    
    Overview
    
    chat
    
    Overview
    ChatResponse class
    CortexAgentChat class
    
    cortex_agent_manager
    
    Overview
    CortexAgentManager class
    
    deployment_config
    
    Overview
    DeploymentConfig class
    DeploymentStatus class
    
    discover_imports
    
    Overview
    discover_imports func
    
    queries
    
    Overview
    Queries class
    QueryCatalog class
    
    tool
    
    Overview
    DefaultTool class
    MaturityLevel class
    Tool class
    ToolRegistry class
    
    verbalize
    
    Overview
    ModelVerbalizer class
    SourceCodeVerbalizer class
    Verbalizer class
    
    http_client func
    APIResponseError class
    CortexAgentApi class
    CortexThreadApi class
  - auth
    
    Overview
    
    handlers
    
    Overview
    
    base
    
    Overview
    DirectAccessAuthError class
    DirectAccessConfigError class
    DirectAccessEndpointStaleError class
    DirectAccessOAuthBrowserOpenError class
    DirectAccessOAuthError class
    DirectAccessOAuthInvalidClientError class
    DirectAccessOAuthStateMismatchError class
    DirectAccessOAuthTimeoutError class
  - client
    
    Overview
    
    client
    
    Overview
    Client class
    
    client_sync
    
    Overview
    ClientSync class
    
    errors
    
    Overview
    
    exceptions
    
    Overview
    AbortedTransactionError class
    ClientAuthError class
    ClientConflictError class
    ClientError class
    ClientInvalidRequestError class
    ClientNotFoundError class
    ClientNotReadyError class
    ClientServerError class
    ClientSqlCompilationError class
    ClientTimeoutError class
    ClientUnknownError class
    DuoSecurityFailed class
    SnowflakeAppMissingException class
    SnowflakeConnectionFailed class
    SnowflakeDatabaseException class
    SnowflakeRaiAppNotStarted class
    
    connect func
    connect_sync func
    from_session func
    from_session_sync func
  - config
    
    Overview
    
    config
    
    Overview
    create_config func
    Config class
    ConfigFromDBT class
    ConfigFromRAIConfigToml class
    ConfigFromSnowflake class
    RAIConfig class
    
    config_fields
    
    Overview
    CompilerConfig class
    DataConfig class
    DebugConfig class
    RetriesConfig class
    ExecutionConfig class
    JobsConfig class
    ModelConfig class
    
    config_reasoners_fields
    
    Overview
    AWSEngineSize attr
    AzureEngineSize attr
    EngineSize attr
    InternalEngineSize attr
    LogicReasonerConfig class
    PrescriptiveReasonerConfig class
    ReasonerConfig class
    ReasonerLogicLqpConfig class
    ReasonersConfig class
    
    connections
    
    Overview
    
    base
    
    Overview
    BaseConnection class
    
    duckdb
    
    Overview
    DuckDBConnection class
    
    local
    
    Overview
    LocalConnection class
    
    snowflake
    
    Overview
    SnowflakeAuthenticator attr
    SnowflakeConnection attr
    ExternalBrowserAuth class
    JWTAuth class
    OAuthAuth class
    OAuthAuthorizationCodeAuth class
    ProgrammaticAccessTokenAuth class
    SnowflakeConnectionBase class
    UsernamePasswordAuth class
    UsernamePasswordMFAAuth class
    
    ConnectionConfig attr
    
    errors
    
    Overview
    
    context
    
    Overview
    ConfigErrorContext class
    ConfigSourceType class
    
    exceptions
    
    Overview
    AttemptedSource class
    ConfigError class
    ConfigFieldMissingError class
    ConfigFieldTypeError class
    ConfigFileNotFoundError class
    ConfigValidationError class
  - semantics
    
    Overview
    
    frontend
    
    Overview
    
    base
    
    Overview
    Primitive attr
    Statement attr
    StatementAndSchema attr
    Value attr
    Aggregate class
    Alias class
    AsBool class
    Chain class
    Concept class
    Data class
    DerivedColumn class
    DerivedTable class
    Distinct class
    DSLBase class
    Expression class
    Field class
    FieldRef class
    FilterBy class
    Fragment class
    Group class
    Literal class
    Match class
    Model class
    New class
    Not class
    NumberConcept class
    Property class
    Reading class
    Ref class
    Relationship class
    Table class
    TableSchema class
    TupleVariable class
    Union class
    Variable class
    
    core
    
    Overview
    Any attr
    AnyEntity attr
    Bool attr
    Boolean attr
    Date attr
    DateTime attr
    Decimal attr
    DefaultNumber attr
    Error attr
    Float attr
    Hash attr
    Int attr
    Int128 attr
    Int64 attr
    Integer attr
    Number attr
    Numeric attr
    ScaledNumber attr
    String attr
    AnyNumber class
    
    reasoners
    
    Overview
    
    graph
    
    Overview
    
    core
    
    Overview
    Graph class
    
    prescriptive
    
    Overview
    
    problem
    
    Overview
    Problem class
    
    all_different func
    implies func
    special_ordered_set_type_1 func
    special_ordered_set_type_2 func
    
    std
    
    Overview
    
    aggregates
    
    Overview
    asc func
    avg func
    bottom func
    count func
    cumsum_asc func
    desc func
    limit func
    max func
    min func
    per func
    rank func
    rank_asc func
    rank_desc func
    string_join func
    sum func
    top func
    Per class
    
    common
    
    Overview
    cast func
    hash func
    parse_uuid func
    range func
    raw_source func
    uuid_to_string func
    
    constraints
    
    Overview
    anyof func
    exclusive func
    oneof func
    unique func
    
    datetime
    
    Overview
    DatePart attr
    DateTimePart attr
    Frequency attr
    days func
    hours func
    microseconds func
    milliseconds func
    minutes func
    months func
    nanoseconds func
    seconds func
    weeks func
    years func
    date class
    datetime class
    ISO class
    
    decimals
    
    Overview
    decimal func
    is_decimal func
    parse func
    parse_decimal func
    precision func
    scale func
    size func
    
    floats
    
    Overview
    float func
    parse_float func
    
    integers
    
    Overview
    int128 func
    int64 func
    parse func
    parse_int128 func
    parse_int64 func
    
    math
    
    Overview
    abs func
    acos func
    acosh func
    acot func
    asin func
    asinh func
    atan func
    atanh func
    cbrt func
    ceil func
    clip func
    cos func
    cosh func
    cot func
    degrees func
    erf func
    erfinv func
    exp func
    factorial func
    floor func
    haversine func
    isclose func
    isinf func
    isnan func
    log func
    log10 func
    log2 func
    maximum func
    minimum func
    natural_log func
    pow func
    radians func
    round func
    sign func
    sin func
    sinh func
    sqrt func
    tan func
    tanh func
    trunc_divide func
    
    numbers
    
    Overview
    digits_to_bits func
    integer func
    is_number func
    number func
    parse func
    parse_number func
    precision func
    scale func
    size func
    
    re
    
    Overview
    
    strings
    
    Overview
    concat func
    contains func
    endswith func
    join func
    len func
    levenshtein func
    like func
    lower func
    regex_match func
    replace func
    split func
    split_part func
    startswith func
    string func
    strip func
    substring func
    upper func
    
    DateTimeValue attr
    DateValue attr
    FloatValue attr
    IntegerValue attr
    NumberValue attr
    StringValue attr
    
    data func
    define func
    distinct func
    not_ func
    require func
    select func
    union func
    where func
  - services
    
    Overview
    
    jobs
    
    Overview
    
    client
    
    Overview
    JobsClient class
    
    client_sync
    
    Overview
    JobsClientSync class
    
    errors
    
    Overview
    JobCapabilityError class
    JobClientDisconnectedError class
    JobConfigurationError class
    JobError class
    JobInvalidRequestError class
    JobNotFoundError class
    JobNotReadyError class
    JobServerError class
    JobTimeoutError class
    JobUnknownError class
    
    reasoners
    
    Overview
    
    client
    
    Overview
    ReasonersClient class
    
    client_sync
    
    Overview
    ReasonersClientSync class
    
    errors
    
    Overview
    ReasonerAuthError class
    ReasonerConflictError class
    ReasonerError class
    ReasonerHttpError class
    ReasonerInvalidRequestError class
    ReasonerNotFoundError class
    ReasonerNotReadyError class
    ReasonerServerError class
    ReasonerTimeoutError class
    ReasonerUnknownError class
    ReasonerValidationException class
- v1.2
  - Overview
  - agent
    
    Overview
    
    cortex
    
    Overview
    
    chat
    
    Overview
    ChatResponse class
    CortexAgentChat class
    
    cortex_agent_manager
    
    Overview
    CortexAgentManager class
    
    deployment_config
    
    Overview
    DeploymentConfig class
    DeploymentStatus class
    
    discover_imports
    
    Overview
    discover_imports func
    
    queries
    
    Overview
    Queries class
    QueryCatalog class
    
    tool
    
    Overview
    DefaultTool class
    MaturityLevel class
    Tool class
    ToolRegistry class
    
    verbalize
    
    Overview
    ModelVerbalizer class
    SourceCodeVerbalizer class
    Verbalizer class
    
    http_client func
    APIResponseError class
    CortexAgentApi class
    CortexThreadApi class
  - auth
    
    Overview
    
    handlers
    
    Overview
    
    base
    
    Overview
    DirectAccessAuthError class
    DirectAccessConfigError class
    DirectAccessEndpointStaleError class
    DirectAccessOAuthBrowserOpenError class
    DirectAccessOAuthError class
    DirectAccessOAuthInvalidClientError class
    DirectAccessOAuthStateMismatchError class
    DirectAccessOAuthTimeoutError class
  - client
    
    Overview
    
    client
    
    Overview
    Client class
    
    client_sync
    
    Overview
    ClientSync class
    
    errors
    
    Overview
    
    exceptions
    
    Overview
    AbortedTransactionError class
    ClientAuthError class
    ClientConflictError class
    ClientError class
    ClientInvalidRequestError class
    ClientNotFoundError class
    ClientNotReadyError class
    ClientServerError class
    ClientSqlCompilationError class
    ClientTimeoutError class
    ClientUnknownError class
    DuoSecurityFailed class
    SnowflakeAppMissingException class
    SnowflakeConnectionFailed class
    SnowflakeDatabaseException class
    SnowflakeRaiAppNotStarted class
    
    connect func
    connect_sync func
    from_session func
    from_session_sync func
  - config
    
    Overview
    
    config
    
    Overview
    create_config func
    Config class
    ConfigFromDBT class
    ConfigFromRAIConfigToml class
    ConfigFromSnowflake class
    RAIConfig class
    
    config_fields
    
    Overview
    CompilerConfig class
    DataConfig class
    DebugConfig class
    RetriesConfig class
    ExecutionConfig class
    JobsConfig class
    ModelConfig class
    
    config_reasoners_fields
    
    Overview
    AWSEngineSize attr
    AzureEngineSize attr
    EngineSize attr
    InternalEngineSize attr
    LogicReasonerConfig class
    PrescriptiveReasonerConfig class
    ReasonerConfig class
    ReasonerLogicLqpConfig class
    ReasonersConfig class
    
    connections
    
    Overview
    
    base
    
    Overview
    BaseConnection class
    
    duckdb
    
    Overview
    
    local
    
    Overview
    LocalConnection class
    
    snowflake
    
    Overview
    SnowflakeAuthenticator attr
    SnowflakeConnection attr
    ExternalBrowserAuth class
    JWTAuth class
    OAuthAuth class
    OAuthAuthorizationCodeAuth class
    ProgrammaticAccessTokenAuth class
    SnowflakeConnectionBase class
    UsernamePasswordAuth class
    UsernamePasswordMFAAuth class
    
    ConnectionConfig attr
    
    errors
    
    Overview
    
    context
    
    Overview
    ConfigErrorContext class
    ConfigSourceType class
    
    exceptions
    
    Overview
    AttemptedSource class
    ConfigError class
    ConfigFieldMissingError class
    ConfigFieldTypeError class
    ConfigFileNotFoundError class
    ConfigValidationError class
  - semantics
    
    Overview
    
    frontend
    
    Overview
    
    base
    
    Overview
    Primitive attr
    Statement attr
    StatementAndSchema attr
    Value attr
    Aggregate class
    Alias class
    AsBool class
    Chain class
    Concept class
    Data class
    DerivedColumn class
    DerivedTable class
    Distinct class
    DSLBase class
    Expression class
    Field class
    FieldRef class
    FilterBy class
    Fragment class
    Group class
    Literal class
    Match class
    Model class
    New class
    Not class
    NumberConcept class
    Property class
    Reading class
    Ref class
    Relationship class
    Table class
    TableSchema class
    TupleVariable class
    Union class
    Variable class
    
    core
    
    Overview
    Any attr
    AnyEntity attr
    Bool attr
    Boolean attr
    Date attr
    DateTime attr
    Decimal attr
    DefaultNumber attr
    Error attr
    Float attr
    Hash attr
    Int attr
    Int128 attr
    Int64 attr
    Integer attr
    Number attr
    Numeric attr
    ScaledNumber attr
    String attr
    AnyNumber class
    
    reasoners
    
    Overview
    
    graph
    
    Overview
    
    core
    
    Overview
    Graph class
    
    prescriptive
    
    Overview
    
    problem
    
    Overview
    Problem class
    
    all_different func
    implies func
    special_ordered_set_type_1 func
    special_ordered_set_type_2 func
    
    std
    
    Overview
    
    aggregates
    
    Overview
    asc func
    avg func
    bottom func
    count func
    cumsum_asc func
    desc func
    limit func
    max func
    min func
    per func
    rank func
    rank_asc func
    rank_desc func
    string_join func
    sum func
    top func
    Per class
    
    common
    
    Overview
    cast func
    hash func
    parse_uuid func
    range func
    raw_source func
    uuid_to_string func
    
    constraints
    
    Overview
    anyof func
    exclusive func
    oneof func
    unique func
    
    datetime
    
    Overview
    DatePart attr
    DateTimePart attr
    Frequency attr
    days func
    hours func
    microseconds func
    milliseconds func
    minutes func
    months func
    nanoseconds func
    seconds func
    weeks func
    years func
    date class
    datetime class
    ISO class
    
    decimals
    
    Overview
    decimal func
    is_decimal func
    parse func
    parse_decimal func
    precision func
    scale func
    size func
    
    floats
    
    Overview
    float func
    parse_float func
    
    integers
    
    Overview
    int128 func
    int64 func
    parse func
    parse_int128 func
    parse_int64 func
    
    math
    
    Overview
    abs func
    acos func
    acosh func
    acot func
    asin func
    asinh func
    atan func
    atanh func
    cbrt func
    ceil func
    clip func
    cos func
    cosh func
    cot func
    degrees func
    erf func
    erfinv func
    exp func
    factorial func
    floor func
    haversine func
    isclose func
    isinf func
    isnan func
    log func
    log10 func
    log2 func
    maximum func
    minimum func
    natural_log func
    pow func
    radians func
    round func
    sign func
    sin func
    sinh func
    sqrt func
    tan func
    tanh func
    trunc_divide func
    
    numbers
    
    Overview
    digits_to_bits func
    integer func
    is_number func
    number func
    parse func
    parse_number func
    precision func
    scale func
    size func
    
    re
    
    Overview
    
    strings
    
    Overview
    concat func
    contains func
    endswith func
    join func
    len func
    levenshtein func
    like func
    lower func
    regex_match func
    replace func
    split func
    split_part func
    startswith func
    string func
    strip func
    substring func
    upper func
    
    DateTimeValue attr
    DateValue attr
    FloatValue attr
    IntegerValue attr
    NumberValue attr
    StringValue attr
    
    data func
    define func
    distinct func
    not_ func
    require func
    select func
    union func
    where func
  - services
    
    Overview
    
    jobs
    
    Overview
    
    client
    
    Overview
    JobsClient class
    
    client_sync
    
    Overview
    JobsClientSync class
    
    errors
    
    Overview
    JobCapabilityError class
    JobClientDisconnectedError class
    JobConfigurationError class
    JobError class
    JobInvalidRequestError class
    JobNotFoundError class
    JobNotReadyError class
    JobServerError class
    JobTimeoutError class
    JobUnknownError class
    
    reasoners
    
    Overview
    
    client
    
    Overview
    ReasonersClient class
    
    client_sync
    
    Overview
    ReasonersClientSync class
    
    errors
    
    Overview
    ReasonerAuthError class
    ReasonerConflictError class
    ReasonerError class
    ReasonerHttpError class
    ReasonerInvalidRequestError class
    ReasonerNotFoundError class
    ReasonerNotReadyError class
    ReasonerServerError class
    ReasonerTimeoutError class
    ReasonerUnknownError class
    ReasonerValidationException class
CLI
- latest
  - Overview
  - completion
    
    Overview
    bash
    fish
    install
    zsh
  - config
    
    Overview
    current
    explain
    profiles
    use
  - jobs
    
    Overview
    cancel
    create
    events
    get
    list
    wait
  - reasoners
    
    Overview
    alter
    create
    delete
    get
    list
    resume
    suspend
    wait
  - commands
  - connect
  - debugger
  - diagnose
  - init
  - version
  - whoami
- v1.0
  - Overview
  - config
    
    Overview
    explain
  - jobs
    
    Overview
    cancel
    create
    events
    get
    list
    wait
  - reasoners
    
    Overview
    alter
    create
    delete
    get
    list
    resume
    suspend
  - connect
  - debugger
  - init
- v1.1
  - Overview
  - config
    
    Overview
    explain
  - jobs
    
    Overview
    cancel
    create
    events
    get
    list
    wait
  - reasoners
    
    Overview
    alter
    create
    delete
    get
    list
    resume
    suspend
  - connect
  - debugger
  - init
- v1.2
  - Overview
  - completion
    
    Overview
    bash
    fish
    install
    zsh
  - config
    
    Overview
    current
    explain
    profiles
    use
  - jobs
    
    Overview
    cancel
    create
    events
    get
    list
    wait
  - reasoners
    
    Overview
    alter
    create
    delete
    get
    list
    resume
    suspend
    wait
  - commands
  - connect
  - debugger
  - init
SQL

GitHub

On this page

Overview
Options
See Also

Version

connect

Terminal window

rai connect

Validate config and database connection.

Options

Section titled “Options”

None.

connect

Options

See Also