cquill - v0.1.0

cquill/error/format

Types

ConnectionConfig

</>

Connection configuration for connection error context

pub type ConnectionConfig {
  ConnectionConfig(
    host: String,
    port: Int,
    database: String,
    user: String,
  )
}

Constructors 

  • ConnectionConfig(
  host: String,
  port: Int,
  database: String,
  user: String,
)

ErrorContext

</>

Context about where an error occurred, for enriched error messages

pub type ErrorContext {
  ErrorContext(
    query: option.Option(String),
    params: option.Option(List(ast.Value)),
    source_location: option.Option(SourceLocation),
    table: option.Option(String),
    operation: option.Option(String),
  )
}

Constructors 

  • ErrorContext(
  query: option.Option(String),
  params: option.Option(List(ast.Value)),
  source_location: option.Option(SourceLocation),
  table: option.Option(String),
  operation: option.Option(String),
)

    Arguments

    query

    The SQL query that failed (if available)

    params

    The query parameters (if available)

    source_location

    Source location in user code (if available)

    table

    The table being operated on (if known)

    operation

    The operation being performed

SourceLocation

</>

Source location in user code where the error originated

pub type SourceLocation {
  SourceLocation(file: String, line: Int, function: String)
}

Constructors 

  • SourceLocation(file: String, line: Int, function: String)

Values

empty_context

</> 
pub fn empty_context() -> ErrorContext

Create an empty error context

format_check_violation

</> 
pub fn format_check_violation(
  constraint: String,
  detail: String,
  context: ErrorContext,
) -> String

Format a check constraint violation

format_connection_failed

</> 
pub fn format_connection_failed(
  reason: String,
  config: ConnectionConfig,
) -> String

Format a connection failed error with troubleshooting hints

format_connection_failed_simple

</> 
pub fn format_connection_failed_simple(reason: String) -> String

Format a connection failed error with minimal context

format_connection_lost

</> 
pub fn format_connection_lost(reason: String) -> String

Format a connection lost error

format_connection_timeout

</> 
pub fn format_connection_timeout(
  config: option.Option(ConnectionConfig),
) -> String

Format a connection timeout error

format_decode_error

</> 
pub fn format_decode_error(
  row: Int,
  column: String,
  expected: String,
  found: String,
) -> String

Format a decode error with detailed context

format_foreign_key_violation

</> 
pub fn format_foreign_key_violation(
  constraint: String,
  table: String,
  column: String,
  references_table: String,
  references_column: String,
) -> String

Format a foreign key constraint violation with rich context

format_foreign_key_violation_error

</> 
pub fn format_foreign_key_violation_error(
  constraint: String,
  detail: String,
  context: ErrorContext,
) -> String

Format a foreign key violation from an AdapterError

format_not_found

</> 
pub fn format_not_found(context: ErrorContext) -> String

Format a “not found” error

format_not_null_violation

</> 
pub fn format_not_null_violation(
  column: String,
  context: ErrorContext,
) -> String

Format a NOT NULL constraint violation

format_pool_exhausted

</> 
pub fn format_pool_exhausted() -> String

Format a pool exhausted error

format_query_failed

</> 
pub fn format_query_failed(
  message: String,
  code: option.Option(String),
  context: ErrorContext,
) -> String

Format a query failed error with context

format_rich_error

</> 
pub fn format_rich_error(
  error: error.AdapterError,
  context: ErrorContext,
) -> String

Format any AdapterError with rich context

format_rich_savepoint_error

</> 
pub fn format_rich_savepoint_error(
  error: error.SavepointError(e),
  context: ErrorContext,
) -> String

Format a savepoint error with rich context

format_rich_transaction_error

</> 
pub fn format_rich_transaction_error(
  error: error.TransactionError(e),
  context: ErrorContext,
) -> String

Format a transaction error with rich context

format_timeout

</> 
pub fn format_timeout(context: ErrorContext) -> String

Format a timeout error

format_too_many_rows

</> 
pub fn format_too_many_rows(
  expected: Int,
  got: Int,
  context: ErrorContext,
) -> String

Format a “too many rows” error

format_unique_violation

</> 
pub fn format_unique_violation(
  constraint: String,
  table: String,
  column: String,
  value: ast.Value,
) -> String

Format a unique constraint violation with rich context

format_unique_violation_error

</> 
pub fn format_unique_violation_error(
  constraint: String,
  detail: String,
  context: ErrorContext,
) -> String

Format a unique violation from an AdapterError

format_value

</> 
pub fn format_value(value: ast.Value) -> String

Format a Value for display in error messages

with_operation

</> 
pub fn with_operation(
  context: ErrorContext,
  operation: String,
) -> ErrorContext

Create a context with operation name

with_params

</> 
pub fn with_params(
  context: ErrorContext,
  params: List(ast.Value),
) -> ErrorContext

Create a context with query parameters

with_query

</> 
pub fn with_query(
  context: ErrorContext,
  query: String,
) -> ErrorContext

Create a context with query information

with_source_location

</> 
pub fn with_source_location(
  context: ErrorContext,
  file: String,
  line: Int,
  function: String,
) -> ErrorContext

Create a context with source location

with_table

</> 
pub fn with_table(
  context: ErrorContext,
  table: String,
) -> ErrorContext

Create a context with table name

✨ Search Document