Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for #6044 #6069

Merged
merged 3 commits into from Jul 15, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/en/reference/schema-representation.rst
Expand Up @@ -76,6 +76,34 @@ All schema assets reside in the ``Doctrine\DBAL\Schema`` namespace.

This chapter is far from being completely documented.

Table
~~~~~~

Represents a table in the schema.

Vendor specific options
^^^^^^^^^^^^^^^^^^^^^^^

The following options, that can be set using `default_table_options`, are completely vendor specific
derrabus marked this conversation as resolved.
Show resolved Hide resolved
and absolutely not portable.

- **charset** (string): The character set to use for the table. Currently only supported
on MySQL.

- **engine** (string): The DB engine used for the table. Currently only supported on MySQL.

- **unlogged** (boolean): Set a PostgreSQL table type as
`unlogged <https://www.postgresql.org/docs/current/sql-createtable.htmll>`_

You can set this options via doctrine configuration. For example:

.. code-block:: yaml

doctrine:
dbal:
default_table_options:
unlogged: true
derrabus marked this conversation as resolved.
Show resolved Hide resolved

Column
~~~~~~

Expand Down