@query-doctor/core 0.8.1 → 0.8.2-rc.1

package/dist/optimizer/statistics.d.mts

@@ -0,0 +1,389 @@
+'use client';
+
+import { Postgres, PostgresTransaction, PostgresVersion } from "../sql/database.mjs";
+import { z } from "zod";
+
+//#region src/optimizer/statistics.d.ts
+type Path = string;
+declare const StatisticsSource: z.ZodUnion<readonly [z.ZodObject<{
+  kind: z.ZodLiteral<"path">;
+  path: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+  kind: z.ZodLiteral<"inline">;
+}, z.core.$strip>]>;
+declare const ExportedStatsStatistics: z.ZodObject<{
+  stawidth: z.ZodNumber;
+  stainherit: z.ZodDefault<z.ZodBoolean>;
+  stadistinct: z.ZodNumber;
+  stanullfrac: z.ZodNumber;
+  stakind1: z.ZodNumber;
+  stakind2: z.ZodNumber;
+  stakind3: z.ZodNumber;
+  stakind4: z.ZodNumber;
+  stakind5: z.ZodNumber;
+  staop1: z.ZodString;
+  staop2: z.ZodString;
+  staop3: z.ZodString;
+  staop4: z.ZodString;
+  staop5: z.ZodString;
+  stacoll1: z.ZodString;
+  stacoll2: z.ZodString;
+  stacoll3: z.ZodString;
+  stacoll4: z.ZodString;
+  stacoll5: z.ZodString;
+  stanumbers1: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+  stanumbers2: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+  stanumbers3: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+  stanumbers4: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+  stanumbers5: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+  stavalues1: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+  stavalues2: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+  stavalues3: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+  stavalues4: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+  stavalues5: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+}, z.core.$strip>;
+declare const ExportedStatsColumns: z.ZodObject<{
+  columnName: z.ZodString;
+  attlen: z.ZodNullable<z.ZodNumber>;
+  stats: z.ZodNullable<z.ZodObject<{
+    stawidth: z.ZodNumber;
+    stainherit: z.ZodDefault<z.ZodBoolean>;
+    stadistinct: z.ZodNumber;
+    stanullfrac: z.ZodNumber;
+    stakind1: z.ZodNumber;
+    stakind2: z.ZodNumber;
+    stakind3: z.ZodNumber;
+    stakind4: z.ZodNumber;
+    stakind5: z.ZodNumber;
+    staop1: z.ZodString;
+    staop2: z.ZodString;
+    staop3: z.ZodString;
+    staop4: z.ZodString;
+    staop5: z.ZodString;
+    stacoll1: z.ZodString;
+    stacoll2: z.ZodString;
+    stacoll3: z.ZodString;
+    stacoll4: z.ZodString;
+    stacoll5: z.ZodString;
+    stanumbers1: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+    stanumbers2: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+    stanumbers3: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+    stanumbers4: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+    stanumbers5: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+    stavalues1: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+    stavalues2: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+    stavalues3: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+    stavalues4: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+    stavalues5: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const ExportedStatsIndex: z.ZodObject<{
+  indexName: z.ZodString;
+  amname: z.ZodDefault<z.ZodString>;
+  relpages: z.ZodNumber;
+  reltuples: z.ZodNumber;
+  relallvisible: z.ZodNumber;
+  relallfrozen: z.ZodOptional<z.ZodNumber>;
+  fillfactor: z.ZodDefault<z.ZodNumber>;
+  columns: z.ZodDefault<z.ZodArray<z.ZodObject<{
+    attlen: z.ZodNullable<z.ZodNumber>;
+  }, z.core.$strip>>>;
+}, z.core.$strip>;
+declare const ExportedStatsV1: z.ZodObject<{
+  tableName: z.ZodString;
+  schemaName: z.ZodString;
+  relpages: z.ZodNumber;
+  reltuples: z.ZodNumber;
+  relallvisible: z.ZodNumber;
+  relallfrozen: z.ZodOptional<z.ZodNumber>;
+  columns: z.ZodDefault<z.ZodArray<z.ZodObject<{
+    columnName: z.ZodString;
+    attlen: z.ZodNullable<z.ZodNumber>;
+    stats: z.ZodNullable<z.ZodObject<{
+      stawidth: z.ZodNumber;
+      stainherit: z.ZodDefault<z.ZodBoolean>;
+      stadistinct: z.ZodNumber;
+      stanullfrac: z.ZodNumber;
+      stakind1: z.ZodNumber;
+      stakind2: z.ZodNumber;
+      stakind3: z.ZodNumber;
+      stakind4: z.ZodNumber;
+      stakind5: z.ZodNumber;
+      staop1: z.ZodString;
+      staop2: z.ZodString;
+      staop3: z.ZodString;
+      staop4: z.ZodString;
+      staop5: z.ZodString;
+      stacoll1: z.ZodString;
+      stacoll2: z.ZodString;
+      stacoll3: z.ZodString;
+      stacoll4: z.ZodString;
+      stacoll5: z.ZodString;
+      stanumbers1: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+      stanumbers2: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+      stanumbers3: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+      stanumbers4: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+      stanumbers5: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+      stavalues1: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+      stavalues2: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+      stavalues3: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+      stavalues4: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+      stavalues5: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+    }, z.core.$strip>>;
+  }, z.core.$strip>>>;
+  indexes: z.ZodArray<z.ZodObject<{
+    indexName: z.ZodString;
+    amname: z.ZodDefault<z.ZodString>;
+    relpages: z.ZodNumber;
+    reltuples: z.ZodNumber;
+    relallvisible: z.ZodNumber;
+    relallfrozen: z.ZodOptional<z.ZodNumber>;
+    fillfactor: z.ZodDefault<z.ZodNumber>;
+    columns: z.ZodDefault<z.ZodArray<z.ZodObject<{
+      attlen: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const ExportedStats: z.ZodUnion<readonly [z.ZodObject<{
+  tableName: z.ZodString;
+  schemaName: z.ZodString;
+  relpages: z.ZodNumber;
+  reltuples: z.ZodNumber;
+  relallvisible: z.ZodNumber;
+  relallfrozen: z.ZodOptional<z.ZodNumber>;
+  columns: z.ZodDefault<z.ZodArray<z.ZodObject<{
+    columnName: z.ZodString;
+    attlen: z.ZodNullable<z.ZodNumber>;
+    stats: z.ZodNullable<z.ZodObject<{
+      stawidth: z.ZodNumber;
+      stainherit: z.ZodDefault<z.ZodBoolean>;
+      stadistinct: z.ZodNumber;
+      stanullfrac: z.ZodNumber;
+      stakind1: z.ZodNumber;
+      stakind2: z.ZodNumber;
+      stakind3: z.ZodNumber;
+      stakind4: z.ZodNumber;
+      stakind5: z.ZodNumber;
+      staop1: z.ZodString;
+      staop2: z.ZodString;
+      staop3: z.ZodString;
+      staop4: z.ZodString;
+      staop5: z.ZodString;
+      stacoll1: z.ZodString;
+      stacoll2: z.ZodString;
+      stacoll3: z.ZodString;
+      stacoll4: z.ZodString;
+      stacoll5: z.ZodString;
+      stanumbers1: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+      stanumbers2: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+      stanumbers3: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+      stanumbers4: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+      stanumbers5: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+      stavalues1: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+      stavalues2: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+      stavalues3: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+      stavalues4: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+      stavalues5: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+    }, z.core.$strip>>;
+  }, z.core.$strip>>>;
+  indexes: z.ZodArray<z.ZodObject<{
+    indexName: z.ZodString;
+    amname: z.ZodDefault<z.ZodString>;
+    relpages: z.ZodNumber;
+    reltuples: z.ZodNumber;
+    relallvisible: z.ZodNumber;
+    relallfrozen: z.ZodOptional<z.ZodNumber>;
+    fillfactor: z.ZodDefault<z.ZodNumber>;
+    columns: z.ZodDefault<z.ZodArray<z.ZodObject<{
+      attlen: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>>;
+  }, z.core.$strip>>;
+}, z.core.$strip>]>;
+type ExportedStats = z.infer<typeof ExportedStats>;
+declare const StatisticsMode: z.ZodDiscriminatedUnion<[z.ZodObject<{
+  kind: z.ZodLiteral<"fromAssumption">;
+  reltuples: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+  kind: z.ZodLiteral<"fromStatisticsExport">;
+  stats: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+    tableName: z.ZodString;
+    schemaName: z.ZodString;
+    relpages: z.ZodNumber;
+    reltuples: z.ZodNumber;
+    relallvisible: z.ZodNumber;
+    relallfrozen: z.ZodOptional<z.ZodNumber>;
+    columns: z.ZodDefault<z.ZodArray<z.ZodObject<{
+      columnName: z.ZodString;
+      attlen: z.ZodNullable<z.ZodNumber>;
+      stats: z.ZodNullable<z.ZodObject<{
+        stawidth: z.ZodNumber;
+        stainherit: z.ZodDefault<z.ZodBoolean>;
+        stadistinct: z.ZodNumber;
+        stanullfrac: z.ZodNumber;
+        stakind1: z.ZodNumber;
+        stakind2: z.ZodNumber;
+        stakind3: z.ZodNumber;
+        stakind4: z.ZodNumber;
+        stakind5: z.ZodNumber;
+        staop1: z.ZodString;
+        staop2: z.ZodString;
+        staop3: z.ZodString;
+        staop4: z.ZodString;
+        staop5: z.ZodString;
+        stacoll1: z.ZodString;
+        stacoll2: z.ZodString;
+        stacoll3: z.ZodString;
+        stacoll4: z.ZodString;
+        stacoll5: z.ZodString;
+        stanumbers1: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+        stanumbers2: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+        stanumbers3: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+        stanumbers4: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+        stanumbers5: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+        stavalues1: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+        stavalues2: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+        stavalues3: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+        stavalues4: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+        stavalues5: z.ZodNullable<z.ZodArray<z.ZodAny>>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    indexes: z.ZodArray<z.ZodObject<{
+      indexName: z.ZodString;
+      amname: z.ZodDefault<z.ZodString>;
+      relpages: z.ZodNumber;
+      reltuples: z.ZodNumber;
+      relallvisible: z.ZodNumber;
+      relallfrozen: z.ZodOptional<z.ZodNumber>;
+      fillfactor: z.ZodDefault<z.ZodNumber>;
+      columns: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        attlen: z.ZodNullable<z.ZodNumber>;
+      }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+  }, z.core.$strip>]>>;
+  source: z.ZodUnion<readonly [z.ZodObject<{
+    kind: z.ZodLiteral<"path">;
+    path: z.ZodString;
+  }, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"inline">;
+  }, z.core.$strip>]>;
+}, z.core.$strip>], "kind">;
+type StatisticsMode = z.infer<typeof StatisticsMode>;
+declare class Statistics {
+  private readonly db;
+  readonly postgresVersion: PostgresVersion;
+  readonly ownMetadata: ExportedStats[];
+  readonly mode: StatisticsMode;
+  private readonly exportedMetadata;
+  static readonly defaultStatsMode: StatisticsMode;
+  constructor(db: Postgres, postgresVersion: PostgresVersion, ownMetadata: ExportedStats[], statsMode: StatisticsMode);
+  static statsModeFromAssumption({
+    reltuples
+  }: {
+    reltuples: number;
+  }): StatisticsMode;
+  /**
+   * Create a statistic mode from stats exported from another database
+   **/
+  static statsModeFromExport(stats: ExportedStats[]): StatisticsMode;
+  static fromPostgres(db: Postgres, statsMode: StatisticsMode): Promise<Statistics>;
+  restoreStats(tx: PostgresTransaction): Promise<{
+    tablesNotInExports: string[];
+    tablesNotInTest: string[];
+    tableNotAnalyzed: string[];
+    statsMissing: {
+      statistic: string;
+      table: string;
+      schema: string;
+      column: string;
+    }[];
+  }>;
+  approximateTotalRows(): number;
+  /**
+   * We have to cast stavaluesN to the correct type
+   * This derives that type for us so it can be used in `array_in`
+   */
+  private stavalueKind;
+  /**
+   * PostgreSQL's anyarray columns in pg_statistic can hold arrays of arrays
+   * for columns with array types (e.g. text[], int4[]). These create
+   * multidimensional arrays that can be "ragged" (sub-arrays with different
+   * lengths). jsonb_to_recordset can't reconstruct ragged multidimensional
+   * arrays from JSON, so we need to drop these values.
+   */
+  private static safeStavalues;
+  private restoreStats17;
+  static dumpStats(db: PostgresTransaction, postgresVersion: PostgresVersion, kind: "anonymous" | "full"): Promise<ExportedStats[]>;
+  /**
+   * Returns all indexes in the database.
+   * ONLY handles regular btree indexes
+   */
+  getExistingIndexes(): Promise<IndexedTable[]>;
+}
+type ColumnMetadata = {
+  columnName: string;
+  dataType: string;
+  isNullable: boolean;
+  stats: ColumnStats | null;
+};
+type ColumnStats = {
+  stainherit: boolean;
+  stanullfrac: number;
+  stawidth: number;
+  stadistinct: number;
+  stakind1: number;
+  stakind2: number;
+  stakind3: number;
+  stakind4: number;
+  stakind5: number;
+  staop1: number;
+  staop2: number;
+  staop3: number;
+  staop4: number;
+  staop5: number;
+  stacoll1: number;
+  stacoll2: number;
+  stacoll3: number;
+  stacoll4: number;
+  stacoll5: number;
+  stanumbers1: number;
+  stanumbers2: number;
+  stanumbers3: number;
+  stanumbers4: number;
+  stanumbers5: number;
+};
+type TableMetadata = {
+  tableName: string;
+  schemaName: string;
+  reltuples: number;
+  relpages: number;
+  relallvisible: number;
+  relallfrozen?: number;
+  columns: ColumnMetadata[];
+};
+type TableName = string;
+type TableStats = {
+  tupleEstimate: bigint;
+  pageCount: number;
+};
+type SerializeResult = {
+  schema: TableMetadata[];
+  serialized: string;
+  sampledRecords: Record<TableName, number>;
+};
+type IndexOrder = "ASC" | "DESC";
+type IndexedTable = {
+  index_columns: Array<{
+    name: string;
+    order: IndexOrder;
+    opclass?: string;
+  }>;
+  is_primary: boolean;
+  is_unique: boolean;
+  index_name: string;
+  index_type: "btree" | "gin" | (string & {});
+  schema_name: string;
+  table_name: string;
+};
+//#endregion
+export { ColumnMetadata, ExportedStats, ExportedStatsColumns, ExportedStatsIndex, ExportedStatsStatistics, ExportedStatsV1, IndexOrder, IndexedTable, Path, SerializeResult, Statistics, StatisticsMode, StatisticsSource, TableMetadata, TableStats };
+//# sourceMappingURL=statistics.d.mts.map

package/dist/optimizer/statistics.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"statistics.d.mts","names":[],"sources":["../../src/optimizer/statistics.ts"],"mappings":";;;;;;KAWY,IAAA;AAAA,cAEC,gBAAA,EAAgB,CAAA,CAAA,QAAA,WAAA,CAAA,CAAA,SAAA;;;;;;cAUhB,uBAAA,EAAuB,CAAA,CAAA,SAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAoCvB,oBAAA,EAAoB,CAAA,CAAA,SAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAMpB,kBAAA,EAAkB,CAAA,CAAA,SAAA;;;;;;;;;;;;cAclB,eAAA,EAAe,CAAA,CAAA,SAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAcf,aAAA,EAAa,CAAA,CAAA,QAAA,WAAA,CAAA,CAAA,SAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAEd,aAAA,GAAgB,CAAA,CAAE,KAAA,QAAa,aAAA;AAAA,cAE9B,cAAA,EAAc,CAAA,CAAA,qBAAA,EAAA,CAAA,CAAA,SAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAYf,cAAA,GAAiB,CAAA,CAAE,KAAA,QAAa,cAAA;AAAA,cAyC/B,UAAA;EAAA,iBAUQ,EAAA;EAAA,SACD,eAAA,EAAiB,eAAA;EAAA,SACjB,WAAA,EAAa,aAAA;EAAA,SAXtB,IAAA,EAAM,cAAA;EAAA,iBACE,gBAAA;EAAA,gBAED,gBAAA,EAAkB,cAAA;cAMf,EAAA,EAAI,QAAA,EACL,eAAA,EAAiB,eAAA,EACjB,WAAA,EAAa,aAAA,IAC7B,SAAA,EAAW,cAAA;EAAA,OAYN,uBAAA,CAAA;IACL;EAAA;IAEA,SAAA;EAAA,IACE,cAAA;;;;SAUG,mBAAA,CAAoB,KAAA,EAAO,aAAA,KAAkB,cAAA;EAAA,OAQvC,YAAA,CACX,EAAA,EAAI,QAAA,EACJ,SAAA,EAAW,cAAA,GACV,OAAA,CAAQ,UAAA;EAMX,YAAA,CAAa,EAAA,EAAI,mBAAA,GAAmB,OAAA;;;;;MA2D9B,SAAA;MACA,KAAA;MACA,MAAA;MACA,MAAA;IAAA;EAAA;EAvDN,oBAAA,CAAA;;;;;UAeQ,YAAA;EAzKuB;;;;;;;EAAA,eA+LhB,aAAA;EAAA,QASD,cAAA;EAAA,OAmhBD,SAAA,CACX,EAAA,EAAI,mBAAA,EACJ,eAAA,EAAiB,eAAA,EACjB,IAAA,yBACC,OAAA,CAAQ,aAAA;;;;;EAuHL,kBAAA,CAAA,GAAsB,OAAA,CAAQ,YAAA;AAAA;AAAA,KA2D1B,cAAA;EACV,UAAA;EACA,QAAA;EACA,UAAA;EACA,KAAA,EAAO,WAAA;AAAA;AAAA,KAGJ,WAAA;EACH,UAAA;EACA,WAAA;EACA,QAAA;EACA,WAAA;EACA,QAAA;EACA,QAAA;EACA,QAAA;EACA,QAAA;EACA,QAAA;EACA,MAAA;EACA,MAAA;EACA,MAAA;EACA,MAAA;EACA,MAAA;EACA,QAAA;EACA,QAAA;EACA,QAAA;EACA,QAAA;EACA,QAAA;EACA,WAAA;EACA,WAAA;EACA,WAAA;EACA,WAAA;EACA,WAAA;AAAA;AAAA,KAGU,aAAA;EACV,SAAA;EACA,UAAA;EACA,SAAA;EACA,QAAA;EACA,aAAA;EACA,YAAA;EACA,OAAA,EAAS,cAAA;AAAA;AAAA,KAGN,SAAA;AAAA,KACO,UAAA;EACV,aAAA;EACA,SAAA;AAAA;AAAA,KAGU,eAAA;EACV,MAAA,EAAQ,aAAA;EACR,UAAA;EACA,cAAA,EAAgB,MAAA,CAAO,SAAA;AAAA;AAAA,KAGb,UAAA;AAAA,KAEA,YAAA;EACV,aAAA,EAAe,KAAA;IAAQ,IAAA;IAAc,KAAA,EAAO,UAAA;IAAY,OAAA;EAAA;EACxD,UAAA;EACA,SAAA;EACA,UAAA;EAEA,UAAA;EAEA,WAAA;EACA,UAAA;AAAA"}