samchon / prisma-markdown

Markdown generator of Prisma, including ERD and descriptions
MIT License
393 stars 18 forks source link

Support `@summary` tag. #4

Closed samchon closed 10 months ago

samchon commented 10 months ago

Requested by someone who prefers JsDoc styled tags.

/// @summary Table for caching.
///
/// @author Samchon
model mv_cache_times {
    //----
    // COLUMNS
    //----
    /// @summary Primary Key.
    ///
    /// @Format uuid
    id String @id @db.Uuid

    /// @summary Target schema.
    schema String @db.VarChar

    /// @summary Target table.
    ///
    /// Database table name.
    table String @db.VarChar

    /// @summary Identifier of target record.
    ///
    /// Even when key type is not string, it must be converted to the string value.
    key String @db.VarChar

    /// The time when the cache data being archived.
    value DateTime @db.Timestamptz

    @@unique([schema, table, key])
}