Changelog; doc test

Author: tyt2y3

CHANGELOG.md

@@ -56,10 +56,39 @@ pub struct TableName(pub Option<SchemaName>, pub DynIden);
 assert_eq!(std::mem::size_of::<Value>(), 32);
 ```
 * `impl From<Expr> for Condition`. Now you can use `Expr` instead of `ConditionExpression`, which has been removed from the public API https://github.com/SeaQL/sea-query/pull/915
+* Replaced `serial` with `GENERATED BY DEFAULT AS IDENTITY` (Postgres) https://github.com/SeaQL/sea-query/pull/918
+```rust
+let table = Table::create()
+    .table(Char::Table)
+    .col(ColumnDef::new(Char::Id).integer().not_null().auto_increment().primary_key())
+    .to_owned();
 
-### Breaking Changes
+assert_eq!(
+    table.to_string(PostgresQueryBuilder),
+    [
+        r#"CREATE TABLE "character" ("#,
+            r#""id" integer GENERATED BY DEFAULT AS IDENTITY NOT NULL PRIMARY KEY,"#,
+        r#")"#,
+    ].join(" ")
+);
+
+// if you needed to support legacy system you can still do:
+let table = Table::create()
+    .table(Char::Table)
+    .col(ColumnDef::new(Char::Id).custom("serial").not_null().primary_key())
+    .to_owned();
+
+assert_eq!(
+    table.to_string(PostgresQueryBuilder),
+    [
+        r#"CREATE TABLE "character" ("#,
+            r#""id" serial NOT NULL PRIMARY KEY"#,
+        r#")"#,
+    ].join(" ")
+);
+```
 
-* Replace `serial` with `GENERATED BY DEFAULT AS IDENTITY`
+### Breaking Changes
 
 * Removed inherent `SimpleExpr` methods that duplicate `ExprTrait`. If you encounter the following error, please add `use sea_query::ExprTrait` in scope https://github.com/SeaQL/sea-query/pull/890
 ```rust
@@ -206,7 +235,7 @@ ALTER TYPE "font" RENAME TO "typeface"
 
 ### New features
 
-* Support for creating functional indexes in PostgreSQL and MySQL https://github.com/SeaQL/sea-query/pull/869
+* Support for creating functional indexes in Postgres and MySQL https://github.com/SeaQL/sea-query/pull/869
 
 ### Enhancements
 

src/table/column.rs

@@ -602,6 +602,42 @@ impl ColumnDef {
     }
 
     /// Use a custom type on this column.
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// use sea_query::{*, tests_cfg::*};
+    ///
+    /// let table = Table::create()
+    ///     .table(Char::Table)
+    ///     .col(ColumnDef::new(Char::Id).custom("new_type").not_null().primary_key())
+    ///     .to_owned();
+    ///
+    /// assert_eq!(
+    ///     table.to_string(MysqlQueryBuilder),
+    ///     [
+    ///         r#"CREATE TABLE `character` ("#,
+    ///             r#"`id` new_type NOT NULL PRIMARY KEY"#,
+    ///         r#")"#,
+    ///     ].join(" ")
+    /// );
+    /// assert_eq!(
+    ///     table.to_string(PostgresQueryBuilder),
+    ///     [
+    ///         r#"CREATE TABLE "character" ("#,
+    ///             r#""id" new_type NOT NULL PRIMARY KEY"#,
+    ///         r#")"#,
+    ///     ].join(" ")
+    /// );
+    /// assert_eq!(
+    ///     table.to_string(SqliteQueryBuilder),
+    ///     [
+    ///        r#"CREATE TABLE "character" ("#,
+    ///            r#""id" new_type NOT NULL PRIMARY KEY"#,
+    ///        r#")"#,
+    ///     ].join(" ")
+    /// );
+    /// ```
     pub fn custom<T>(&mut self, name: T) -> &mut Self
     where
         T: IntoIden,