Libraries v5.0.0
    Preparing search index...

    Class AliasedQueryBuilder<T, Row, P, Connected>

    Immutable flat joined read. Supply select() before accessing rowSchema or executing.

    Type Parameters

    Hierarchy

    Index
    • Internal

      Create through query(knex, alias(schema, name)).

      Type Parameters

      Parameters

      • planner: AliasedQuerySource<T, any>

      Returns AliasedQueryBuilder<T, Row, P, Connected>

    "[PARAMETER_READER]": AliasParameterReader

    Type-only fluent return constructor.

    "[PARAMETER_STATE]": P

    Type-only ordered argument contract.

    • get rowSchema(): Row

      Exact structural schema, stable across operations that do not change selection.

      Returns Row

    • Internal

      Cached SELECT execution and independent materialization.

      Returns CompiledReader

    • Parameters

      • predicate: ReadPredicate

      Returns this

    • Configure raw SQL once and declare its complete output contract.

      Type Parameters

      Parameters

      • configure: (query: QueryBuilder) => QueryBuilder<any, any> | undefined
      • options: QueryOutput<O>

      Returns OpaqueQuery<O>

    • Internal

      Compile selected fields, casting exact numeric values before driver parsing.

      Parameters

      • Optionalmode: typeof COMPILE_PARAMETERS

      Returns QueryBuilder

    • Execute one statement and validate/decode its detached results.

      Returns Promise<InferType<Row>[]>

    • Fetch the first selected row, or undefined.

      Returns Promise<InferType<Row> | undefined>

    • Append trusted raw ordering with captured bindings; ref() quotes mapped aliased columns.

      Type Parameters

      • const A extends readonly RawBinding[]

      Parameters

      • sql: string
      • Optionalbindings: A & WithoutParameters<NoInfer<A>>

      Returns QueryView<AliasedQueryBuilder<T, Row, P, Connected>, Connected>

    • Parameters

      • query: QueryBuilder

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              P extends ParameterState ? P : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Type Parameters

      Parameters

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              ValueParameters<P, A, PredicateValue<ReadAliasTables<T>, S>> extends ParameterState
                  ? ParameterState & ValueParameters<
                      P,
                      A,
                      PredicateValue<ReadAliasTables<T>, S>,
                  >
                  : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Parameters

      • query: QueryBuilder

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              P extends ParameterState ? P : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Type Parameters

      Parameters

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              ValueParameters<P, A, PredicateValue<ReadAliasTables<T>, S>> extends ParameterState
                  ? ParameterState & ValueParameters<
                      P,
                      A,
                      PredicateValue<ReadAliasTables<T>, S>,
                  >
                  : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Type Parameters

      • const A extends readonly RawBinding[]

      Parameters

      • sql: string
      • bindings: A & WithoutParameters<NoInfer<A>>

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              P extends ParameterState ? P : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Parameters

      • sql: string

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              P extends ParameterState ? P : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Returns ReadPredicateContext<ReadAliasTables<T>>

    • Replace the projection with trusted SQL and an explicit output contract.

      Type Parameters

      Parameters

      • sql: string
      • bindings: readonly RawBinding[]
      • options: QueryOutput<O>

      Returns OpaqueQuery<O>

    • Awaiting executes this reader; repeated awaits execute again.

      Type Parameters

      • R = InferType<Row>[]
      • E = never

      Parameters

      • Optionalresolve: ((rows: InferType<Row>[]) => R | PromiseLike<R>) | null
      • Optionalreject: ((error: any) => E | PromiseLike<E>) | null

      Returns Promise<R | E>

    • Return an independent mutable Knex snapshot.

      Returns QueryBuilder

    • Render SQL for debugging without executing it.

      Returns string

    • Type Parameters

      • S extends string | ((columns: C) => AliasedColumn<any>)
      • const A extends readonly [unknown, unknown]

      Parameters

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              ValueParameters<P, A, PredicateValue<ReadAliasTables<T>, S>> extends ParameterState
                  ? ParameterState & ValueParameters<
                      P,
                      A,
                      PredicateValue<ReadAliasTables<T>, S>,
                  >
                  : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Parameters

      • query: QueryBuilder

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              P extends ParameterState ? P : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Type Parameters

      Parameters

      • column: S
      • value: A & (
            A extends QueryParameter<string>
                ? CheckParameterValue<
                    P,
                    NoInfer<A>,
                    PredicateValue<ReadAliasTables<T>, S>,
                >
                : string
        )

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              ValueParameters<P, A, PredicateValue<ReadAliasTables<T>, S>> extends ParameterState
                  ? ParameterState & ValueParameters<
                      P,
                      A,
                      PredicateValue<ReadAliasTables<T>, S>,
                  >
                  : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Match a fixed value tuple or captured SELECT subquery.

      Type Parameters

      Parameters

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              ValueParameters<P, A, PredicateValue<ReadAliasTables<T>, S>> extends ParameterState
                  ? ParameterState & ValueParameters<
                      P,
                      A,
                      PredicateValue<ReadAliasTables<T>, S>,
                  >
                  : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Type Parameters

      Parameters

      • column: S
      • value: A & (
            A extends QueryParameter<string>
                ? CheckParameterValue<
                    P,
                    NoInfer<A>,
                    PredicateValue<ReadAliasTables<T>, S>,
                >
                : string
        )

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              ValueParameters<P, A, PredicateValue<ReadAliasTables<T>, S>> extends ParameterState
                  ? ParameterState & ValueParameters<
                      P,
                      A,
                      PredicateValue<ReadAliasTables<T>, S>,
                  >
                  : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Negate equality while preserving ordinary SQL null semantics.

      Type Parameters

      Parameters

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              ValueParameters<P, A, PredicateValue<ReadAliasTables<T>, S>> extends ParameterState
                  ? ParameterState & ValueParameters<
                      P,
                      A,
                      PredicateValue<ReadAliasTables<T>, S>,
                  >
                  : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Type Parameters

      • S extends string | ((columns: C) => AliasedColumn<any>)
      • const A extends readonly [unknown, unknown]

      Parameters

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              ValueParameters<P, A, PredicateValue<ReadAliasTables<T>, S>> extends ParameterState
                  ? ParameterState & ValueParameters<
                      P,
                      A,
                      PredicateValue<ReadAliasTables<T>, S>,
                  >
                  : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Parameters

      • query: QueryBuilder

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              P extends ParameterState ? P : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Type Parameters

      Parameters

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              ValueParameters<P, A, PredicateValue<ReadAliasTables<T>, S>> extends ParameterState
                  ? ParameterState & ValueParameters<
                      P,
                      A,
                      PredicateValue<ReadAliasTables<T>, S>,
                  >
                  : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Trusted SQL with concrete bindings; use a typed predicate for placeholders.

      Type Parameters

      • const A extends readonly RawBinding[]

      Parameters

      • sql: string
      • bindings: A & WithoutParameters<NoInfer<A>>

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              P extends ParameterState ? P : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >

    • Trusted SQL with concrete bindings; use a typed predicate for placeholders.

      Parameters

      • sql: string

      Returns QueryView<
          AliasedQueryBuilder<
              T,
              Row,
              P extends ParameterState ? P : never,
              Connected extends true ? true : false,
          >,
          Connected extends true ? true : false,
      >