Skip to content

DebugConfig

relationalai.config.config_fields

Configure debug server and error-reporting behavior.

This controls local debugging features such as the debug server host/port and whether extra debug logs or full stack traces are shown.

Examples

Minimal YAML (in raiconfig.yaml):

default_connection: sf
connections:
sf:
type: snowflake
# ...
debug:
show_full_traces: true

Configure debug settings using a dict:

from relationalai.config import create_config
cfg = create_config(debug={"show_full_traces": True})

Attributes

.enabled

DebugConfig.enabled: bool

Enable debug mode.

.host

DebugConfig.host: (str, optional)

Debug server host. If omitted, a default host is used.

.port

DebugConfig.port: int

Debug server port.

.show_debug_logs

DebugConfig.show_debug_logs: bool

Show debug log messages.

.show_full_traces

DebugConfig.show_full_traces: bool

Show full stack traces in errors.

Inheritance Hierarchy

DebugConfigpydantic.BaseModel