Field Indexes

Vona provides a mechanism to create field indexes. Just declare the field indexes and the system will automatically create them.

Create meta.index

Vona uses Bean meta.index to uniformly configure the field indexes of the module.

1. Cli command

$ vona :create:bean meta index --module=demo-student

2. Menu command

TIP

Context Menu - [Module Path]: Vona Meta/Index

meta.index Definition

@Meta()
export class MetaIndex extends BeanBase {}

Configure field indexes: normal style

@Meta({
  indexes: {
    demoStudent: 'name',
  },
})
class MetaIndex {}

• demoStudent: Table name
• 'name': field name, type is string | string[]

Configure field indexes: typed style

In order to make the code higher quality and easier to maintain, we can also use a typed code style.

import { $tableColumns } from 'vona-module-a-ormutils';

@Meta({
  indexes: {
    ...$tableColumns('demoStudent', 'name'),
  },
})
class MetaIndex {}

• $tableColumns: Generate typed table name and field name/names

App Config

Field indexes can be configured in App Config.

src/backend/config/config/config.ts

// onions
config.onions = {
  meta: {
    'demo-student:index': {
      indexes: {
        ...$tableColumns('demoStudent', 'name'),
      },
    },
  },
};