Method addIndex

packages/sql/src/schema/DatabaseTable.ts:1126–1283

(
    meta: EntityMetadata,
    index: {
      properties?: string | string[];
      name?: string;
      type?: string;
      expression?: string | IndexCallback<any>;
      where?: string | Dictionary;
      deferMode?: DeferMode | `${DeferMode}`;
      options?: Dictionary;
      columns?: {
        name: string;
        sort?: 'ASC' | 'DESC' | 'asc' | 'desc';
        nulls?: 'FIRST' | 'LAST' | 'first' | 'last';
        length?: number;
        collation?: string;
      }[];
      include?: string | string[];
      fillFactor?: number;
      invisible?: boolean;
      disabled?: boolean;
      clustered?: boolean;
    },
    type: 'index' | 'unique' | 'primary',
  )

  }

  addIndex(
    meta: EntityMetadata,
    index: {
      properties?: string | string[];
      name?: string;
      type?: string;
      expression?: string | IndexCallback<any>;
      where?: string | Dictionary;
      deferMode?: DeferMode | `${DeferMode}`;
      options?: Dictionary;
      columns?: {
        name: string;
        sort?: 'ASC' | 'DESC' | 'asc' | 'desc';
        nulls?: 'FIRST' | 'LAST' | 'first' | 'last';
        length?: number;
        collation?: string;
      }[];
      include?: string | string[];
      fillFactor?: number;
      invisible?: boolean;
      disabled?: boolean;
      clustered?: boolean;
    },
    type: 'index' | 'unique' | 'primary',
  ) {
    // If columns are specified but properties are not, derive properties from column names
    if (
      index.columns?.length &&
      !index.expression &&
      (!index.properties || Utils.asArray(index.properties).length === 0)
    ) {
      index = { ...index, properties: index.columns.map(c => c.name) };
    }

    const properties = Utils.unique(
      Utils.flatten(
        Utils.asArray(index.properties).map(prop => {
          const parts = prop.split('.');
          const root = parts[0];

          if (meta.properties[prop]) {
            if (meta.properties[prop].embeddedPath) {
              return [meta.properties[prop].embeddedPath.join('.')];
            }

            return meta.properties[prop].fieldNames;
          }

          const rootProp = meta.properties[root];

          // inline embedded property index, we need to find the field name of the child property
          if (rootProp?.embeddable && !rootProp.object && parts.length > 1) {
            const expand = (p: EntityProperty, i: number): string => {
              if (parts.length === i) {
                return p.fieldNames[0];
              }

              return expand(p.embeddedProps[parts[i]], i + 1);