Entity schemas documentation

Issue type:

[x] question [ ] bug report [ ] feature request [x] documentation issue

Database system/driver:

[ ] cordova [ ] mongodb [ ] mssql [x] mysql / mariadb [ ] oracle [ ] postgres [ ] sqlite [ ] sqljs [ ] react-native

TypeORM version:

[ ] latest [x] @next [ ] 0.x.x (or put your version here)

Hey how well implemented are entity schemas at this point? I see some documentation has emerged recently. I would like to see some examples how different decorators get translated in the schema files like GeneratedColumn, CreateDateColumn, UpdateDateColumn.

If i remove the decorators on the entities and create schema files targeting these entities instead then will my existing code (repositories/query-builders/enitity-manager) work without needing any additional modifications?

[jebbdomingo]

Any example how to apply the separate schema to an entity?

[johannesschobel]

Hey @jebbdomingo , I managed to solve it like this:

const userRepository = getRepository<User>('UserSchema');
const user = await userRepository.findOne(1);

Whereas User is the Interface and UserSchema is the EntitySchema that describes the User. Respective UserSchema may look like this:

import { EntitySchema } from 'typeorm';
import { User } from './user.entity';

export const UserSchema = new EntitySchema<User>({
  name: 'UserSchema',
  tableName: 'users',

  columns: {
    id: {
      type: 'uuid',
      primary: true,
      generated: 'uuid',
    },

    email: {
      type: 'varchar',
      length: 150,
      unique: true,
    },
    username: {
      type: 'varchar',
      length: 150,
      unique: true,
    },
    password: {
      type: 'varchar',
      length: 150,
    },

    createdAt: {
      name: 'created_at',
      type: 'timestamp with time zone',
      createDate: true,
    },
    updatedAt: {
      name: 'updated_at',
      type: 'timestamp with time zone',
      updateDate: true,
    }
  },
  indices: [
    // ...
  ],
  relations: {
    // ...
  }
});

again, the User in this schema description is the previously mentioned Interface!

Maybe this helps?