Class SubQuery<S, PN, PR, PQRT, CRN, CN, CR>

constructor

• new SubQuery<
      S extends Schema,
      PN extends string,
      PR extends Record,
      PQRT extends "Records" | "QueryResult" | "SingleRecord" | "Count",
      CRN extends string = ChildRelationshipNames<S, PN>,
      CN extends string = ChildRelationshipSObjectName<S, PN, CRN>,
      CR extends Record = Record,
  >(
      conn: Connection<S>,
      relName: CRN,
      config: QueryConfig<S, CN>,
      parent: Query<S, PN, PR, PQRT>,
  ): SubQuery<S, PN, PR, PQRT, CRN, CN, CR>

  Type Parameters

  • S extends Schema
  • PN extends string
  • PR extends Record
  • PQRT extends "Records" | "QueryResult" | "SingleRecord" | "Count"
  • CRN extends string = ChildRelationshipNames<S, PN>
  • CN extends string = ChildRelationshipSObjectName<S, PN, CRN>
  • CR extends Record = Record

  Parameters

  • conn: Connection<S>
  • relName: CRN
  • config: QueryConfig<S, CN>
  • parent: Query<S, PN, PR, PQRT>

  Returns SubQuery<S, PN, PR, PQRT, CRN, CN, CR>

_parent

_query

_relName

offset

orderby

_expandFields

• _expandFields(): Promise<void>

  Returns Promise<void>

end

• end<
      CRP extends
          {}
          | SObjectChildRelationshipRecord_<CRN, CR> = SObjectChildRelationshipProp<
          CRN,
          CR,
      >,
      PR1 extends Record = PR & CRP,
  >(): Query<S, PN, PR1, PQRT>

  Back the context to parent query object

  Type Parameters

  • CRP extends {} | SObjectChildRelationshipRecord_<CRN, CR> = SObjectChildRelationshipProp<CRN, CR>
  • PR1 extends Record = PR & CRP

  Returns Query<S, PN, PR1, PQRT>

limit

• limit(limit: number): SubQuery<S, PN, PR, PQRT, CRN, CN, CR>

  Limit the returning result

  Parameters

  • limit: number

  Returns SubQuery<S, PN, PR, PQRT, CRN, CN, CR>

select

• select<
      R extends Record = Record,
      FP extends
      
              | string
              | {
                  [K in string]?: | "*"
                  | FieldPath_1<
                      Extract<S["SObjects"][CN]["ParentReferences"][K], SObjectDefinition>,
                      Extract<(...)[(...)][CN]["ParentReferences"][K], SObjectDefinition>["ParentReferences"],
                  >[]
              } = FieldPathSpecifier<S, CN>,
      FPC extends FieldProjectionConfig = FieldPathScopedProjection<S, CN, FP>,
  >(
      fields: QueryField<S, CN, FP>,
  ): SubQuery<S, PN, PR, PQRT, CRN, CN, SObjectRecord<S, CN, FPC, R>>

  Type Parameters

  • R extends Record = Record
  • FP extends
        | string
        | {
            [K in string]?: | "*"
            | FieldPath_1<
                Extract<S["SObjects"][CN]["ParentReferences"][K], SObjectDefinition>,
                Extract<(...)[(...)][CN]["ParentReferences"][K], SObjectDefinition>["ParentReferences"],
            >[]
        } = FieldPathSpecifier<S, CN>
  • FPC extends FieldProjectionConfig = FieldPathScopedProjection<S, CN, FP>

  Parameters

  • fields: QueryField<S, CN, FP>

  Returns SubQuery<S, PN, PR, PQRT, CRN, CN, SObjectRecord<S, CN, FPC, R>>

skip

• skip(offset: number): SubQuery<S, PN, PR, PQRT, CRN, CN, CR>

  Skip records

  Parameters

  • offset: number

  Returns SubQuery<S, PN, PR, PQRT, CRN, CN, CR>

sort

• sort(sort: QuerySort<S, CN>): this

  Set query sort with direction

  Parameters

  • sort: QuerySort<S, CN>

  Returns this

• sort(
      sort: string | Extract<keyof S["SObjects"][CN]["Fields"], string>,
      dir: SortDir,
  ): this

  Set query sort with direction

  Parameters

  • sort: string | Extract<keyof S["SObjects"][CN]["Fields"], string>
  • dir: SortDir

  Returns this

where

• where(conditions: string | QueryCondition<S, CN>): this

  Parameters

  • conditions: string | QueryCondition<S, CN>

  Returns this