[MySQL] feat(mysql): Support vectorIndex and secondaryEngineAttribute

[dengfuping]

Background

• [FEATURE]: Implement CREATE VECTOR INDEX for MySQL #3695

vectorIndex and secondaryEngineAttribute usage

• MySQL vector index reference: https://planetscale.com/docs/vectors/reference#vector-index

const users = mysqlTable(
    "users",
    {
      id: bigint({ mode: "bigint" }).autoincrement().primaryKey(),
      name: varchar({ length: 255 }).notNull(),
      embedding: vector("embedding", { length: 3 }),
    },
    (table) => {
      return {
        idx_embedding: vectorIndex({
          name: "idx_embedding",
          secondaryEngineAttribute: '{"type":"spann", "distance":"cosine"}',
        }).on(table.embedding),
      };
    }
  )

• Related SQL of create index:

CREATE VECTOR INDEX `idx_embedding` ON `users` (`embedding`) SECONDARY_ENGINE_ATTRIBUTE=\'{"type":"spann", "distance":"cosine"}\';

[kravetsone]

secondaryEngineAttribute: '{"type":"spann", "distance":"cosine"}',

Why not object?

[dengfuping]

@kravetsone

• SECONDARY_ENGINE_ATTRIBUTE follow the type in MySQL:

• Vector index and SECONDARY_ENGINE_ATTRIBUTE usage sample is in https://planetscale.com/docs/vectors/reference#vector-index:

[kravetsone]

@kravetsone

• SECONDARY_ENGINE_ATTRIBUTE follow the type defined e in MySQL:

• Vector index and SECONDARY_ENGINE_ATTRIBUTE usage sample is in https://planetscale.com/docs/vectors/reference#vector-index:

yeah but it json

so we can use object (with type-safety) as input and serialize it to string

[dengfuping]

@kravetsone Considering that most frameworks treat secondaryEngineAttribute as string type, I think that it's more consistent to use string type.

• vitess wrapper: https://github.com/vitessio/vitess/blob/main/go/vt/sqlparser/ast.go#L1906

• eggjs: https://www.npmjs.com/package/@eggjs/tegg-dal-plugin