Simple Data Analysis Core - v2.1.14
    Preparing search index...

    Class SDAError

    An error thrown when a SQL query fails. It carries the SDA method that triggered the query, the parameters passed to it, the SQL query itself, and the original error as cause.

    try {
      await table.selectColumns("aColumnThatDoesNotExist").run();
    } catch (error) {
      if (error instanceof SDAError) {
        console.log(error.method); // "selectColumns()"
        console.log(error.query); // The SQL query that failed
        console.log(error.cause); // The original DuckDB error
      }
    }

    Hierarchy

    • Error
      • SDAError
    Index
    constructor
    cause? message method name parameters query stack? stackTraceLimit
    captureStackTrace prepareStackTrace

    • Creates an error that preserves the failing query and its original cause.

      Parameters

      • options: {
            cause: unknown;
            method: string | null;
            parameters: { [key: string]: unknown } | null;
            query: string;
        }

        Details of the failed query.

        • cause: unknown

          The original error thrown while executing the query.

        • method: string | null

          The SDA method that triggered the query, or null.

        • parameters: { [key: string]: unknown } | null

          The method's arguments, or null.

        • query: string

          The SQL statement that failed.

      Returns SDAError

      const error = new SDAError({
        method: "example()",
        parameters: { column: "missing" },
        query: "SELECT missing FROM data",
        cause: new Error("Column not found"),
      });
      console.log(error.method, error.cause);
    cause?: unknown
    message: string
    method: string | null

    The SDA method that triggered the failing query.

    name: string
    parameters: { [key: string]: unknown } | null

    The parameters passed to the method.

    query: string

    The SQL query that failed.

    stack?: string
    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods