Doctrine DBAL
  1. Doctrine DBAL
  2. DBAL-764

Provide a reference of the portable Column types and options

    Details

    • Type: Documentation Documentation
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 2.4.2
    • Fix Version/s: 2.5
    • Component/s: Schema Managers
    • Security Level: All
    • Labels:

      Description

      One difficulty I had with the existing documentation and tools for DBAL was the lack of a reference for what the valid values were (e.g. "notnull" instead of "not null").

      See http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/schema-representation.html for example: some values are given, but there is no reference list, and anything put just in documentation would incur the risk of not remaining updated.

      So I tried to guess-generate the information from the code, like this: https://gist.github.com/FGM/8261606 (also attached).

      Unless an equivalent already exists somewhere, I think it could be useful to have something like this in upcoming releases.

        Activity

        Hide
        Steve Müller added a comment -

        Documentation supplied in PR: https://github.com/doctrine/dbal/pull/502
        Please give a shout if something is missing, wrong, arguable or what...

        Show
        Steve Müller added a comment - Documentation supplied in PR: https://github.com/doctrine/dbal/pull/502 Please give a shout if something is missing, wrong, arguable or what...
        Hide
        Frederic G. MARAND added a comment -

        Glad to see so much information in your PR. Did you create it from scratch or was it available elsewhere ?

        Also, since the project seems to have some difficulty keeping up with "guide"-type documentation vs code evolutions, wouldn't it be feasible to have most of this information be generated from code (or phpdoc), to have it be automatically maintained when code changes ?

        Show
        Frederic G. MARAND added a comment - Glad to see so much information in your PR. Did you create it from scratch or was it available elsewhere ? Also, since the project seems to have some difficulty keeping up with "guide"-type documentation vs code evolutions, wouldn't it be feasible to have most of this information be generated from code (or phpdoc), to have it be automatically maintained when code changes ?
        Hide
        Steve Müller added a comment -

        Frederic G. MARAND I created it from scratch as you requested in this ticket. We are aware the DBAL documentation isn't in the best shape, but we are working on it step by step. Please bare with us if it takes some time to catch up all the missing things.
        An API documentation is always autogenerated and published automatically on the Doctrine website: http://www.doctrine-project.org/api/dbal/2.4/index.html

        Show
        Steve Müller added a comment - Frederic G. MARAND I created it from scratch as you requested in this ticket. We are aware the DBAL documentation isn't in the best shape, but we are working on it step by step. Please bare with us if it takes some time to catch up all the missing things. An API documentation is always autogenerated and published automatically on the Doctrine website: http://www.doctrine-project.org/api/dbal/2.4/index.html
        Hide
        Frederic G. MARAND added a comment -

        OK, i was afraid it was somewhere and I had missed it. Beyond that, don't you think it would be a good idea to have such lists of information be maintained as phpdoc rather than in the doc sources, and exported instead of being types. This would allow such commands as the one I had imagined (obviously better done).

        Show
        Frederic G. MARAND added a comment - OK, i was afraid it was somewhere and I had missed it. Beyond that, don't you think it would be a good idea to have such lists of information be maintained as phpdoc rather than in the doc sources, and exported instead of being types. This would allow such commands as the one I had imagined (obviously better done).
        Hide
        Doctrine Bot added a comment -

        A related Github Pull-Request [GH-502] was closed:
        https://github.com/doctrine/dbal/pull/502

        Show
        Doctrine Bot added a comment - A related Github Pull-Request [GH-502] was closed: https://github.com/doctrine/dbal/pull/502
        Show
        Steve Müller added a comment - Fixed in commit: https://github.com/doctrine/dbal/commit/6adc9ee1cb51e4ffef9811cf1d63de152824dd0d

          People

          • Assignee:
            Steve Müller
            Reporter:
            Frederic G. MARAND
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: