8000 Release v1.2.1; Documention · FirebirdSQL/python3-lib@9f46d25 · GitHub
[go: up one dir, main page]
Skip to content

Commit 9f46d25

Browse files
pcisarpcisar
committed
Release v1.2.1; Documention
1 parent 6feab7b commit 9f46d25
  • js
  • bootstrap-sphinx.css
  • bootstrap-sphinx.js
  • bootswatch-2.3.2
  • bootswatch-3.3.7
  • bootswatch-3.4.1
  • dialog-note.png
  • dialog-seealso.png
  • dialog-topic.png
  • dialog-warning.png
  • doctools.js
  • documentation_options.js
  • fb-favicon.png
  • file.png
  • jquery-3.5.1.js
  • jquery-3.6.0.js
  • jquery.js
  • js
  • language_data.js
  • minus.png
  • plus.png
  • pygments.css
  • searchtools.js
  • sphinx_highlight.js
  • underscore-1.13.1.js
  • underscore-1.3.1.js
  • underscore.js
  • changelog.html
  • genindex.html
  • index.html
  • license.html
  • objects.inv
  • py-modindex.html
  • ref-gstat.html
  • ref-log.html
  • ref-logmsgs.html
  • ref-monitor.html
  • ref-schema.html
  • ref-trace.html
  • reference.html
  • search.html
  • searchindex.js
  • usage-guide.html
  • docSet.dsidx
  • icon.png
  • index.txt
  • requirements.txt
  • pyproject.toml

    • Some content is hidden

    Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

    162 files changed

    +80763
    -6
    lines changed

    ‎docs/_static/fb-favicon.png

    486 Bytes
    Loading

    ‎docs/changelog.txt

    Lines changed: 16 additions & 0 deletions
    Original file line numberDiff line numberDiff line change
    @@ -2,6 +2,18 @@
    22
    Changelog
    33
    #########
    44

    5+
    Version 1.2.1
    6+
    =============
    7+
    8+
    * Code optionizations.
    9+
    * New: Documentation is now also provided as Dash_ / Zeal_ docset, downloadable from releases_ at github.
    10+
    * Tests now properly work on Firebird 4.0
    11+
    12+
    .. module:: firebird.lib.schema
    13+
    :noindex:
    14+
    15+
    * schema: Fixed problems with system PSQL functions and system packages.
    16+
    517
    Version 1.2.0
    618
    =============
    719

    @@ -37,3 +49,7 @@ Version 1.0.0
    3749
    =============
    3850

    3951
    Initial release.
    52+
    53+
    .. _releases: https://github.com/FirebirdSQL/python3-lib/releases
    54+
    .. _Dash: https://kapeli.com/dash
    55+
    .. _Zeal: https://zealdocs.org/

    ‎docs/conf.py

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -19,14 +19,14 @@
    1919
    # -- Project information -----------------------------------------------------
    2020

    2121
    project = 'firebird-lib'
    22-
    copyright = '2020-2021, The Firebird Project'
    22+
    copyright = '2020-2022, The Firebird Project'
    2323
    author = 'Pavel Císař'
    2424

    2525
    # The short X.Y version
    26-
    version = '1.2.0'
    26+
    version = '1.2.1'
    2727

    2828
    # The full version, including alpha/beta/rc tags
    29-
    release = '1.2.0'
    29+
    release = '1.2.1'
    3030

    3131

    3232
    # -- General configuration ---------------------------------------------------

    ‎docs/firebird-lib.docset/Contents/Info.plist

    Lines changed: 22 additions & 0 deletions
    Original file line numberDiff line numberDiff line change
    @@ -0,0 +1,22 @@
    1+
    <?xml version="1.0" encoding="UTF-8"?>
    2+
    <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
    3+
    <plist version="1.0">
    4+
    <dict>
    5+
    <key>CFBundleIdentifier</key>
    6+
    <string>firebird-lib</string>
    7+
    <key>CFBundleName</key>
    8+
    <string>firebird-lib</string>
    9+
    <key>DashDocSetDeclaredInStyle</key>
    10+
    <string>originalName</string>
    11+
    <key>DashDocSetFallbackURL</key>
    12+
    <string>https://firebird-lib.readthedocs.io/en/latest/</string>
    13+
    <key>DashDocSetFamily</key>
    14+
    <string>python</string>
    15+
    <key>DocSetPlatformFamily</key>
    16+
    <string>firebird-lib</string>
    17+
    <key>isDashDocset</key>
    18+
    <true/>
    19+
    <key>isJavaScriptEnabled</key>
    20+
    <false/>
    21+
    </dict>
    22+
    </plist>

    ‎docs/firebird-lib.docset/Contents/Resources/Documents/.buildinfo

    Lines changed: 4 additions & 0 deletions
    Original file line numberDiff line numberDiff line change
    @@ -0,0 +1,4 @@
    1+
    # Sphinx build info version 1
    2+
    # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
    3+
    config: b3e32615185ea05915feca330624737f
    4+
    tags: 645f666f9bcd5a90fca523b33c5a78b7

    ‎docs/firebird-lib.docset/Contents/Resources/Documents/_sources/changelog.txt

    Lines changed: 55 additions & 0 deletions
    Original file line numberDiff line numberDiff line change
    @@ -0,0 +1,55 @@
    1+
    #########
    2+
    Changelog
    3+
    #########
    4+
    5+
    Version 1.2.1
    6+
    =============
    7+
    8+
    * Code optionizations.
    9+
    * New: Documentation is now also provided as Dash_ / Zeal_ docset, downloadable from releases_ at github.
    10+
    * Tests now properly work on Firebird 4.0
    11+
    12+
    .. module:: firebird.lib.schema
    13+
    :noindex:
    14+
    15+
    * schema: Fixed problems with system PSQL functions and system packages.
    16+
    17+
    Version 1.2.0
    18+
    =============
    19+
    20+
    .. module:: firebird.lib.schema
    21+
    :noindex:
    22+
    23+
    * schema: `Sequence` ALTER SQL uses RESTART instead START keyword.
    24+
    * schema: Fix index type in `Constraint` and `Table` CREATE SQL.
    25+
    * schema: Added `insert` SQL for `.Table`.
    26+
    27+
    .. module:: firebird.lib.trace
    28+
    :noindex:
    29+
    30+
    * trace: Add `TransactionInfo.initial_id`.
    31+
    * trace: Add `EventCommitRetaining.new_transaction_id` and `EventRollbackRetaining.new_transaction_id`.
    32+
    * trace: `EventFreeStatement.transaction_id` and `EventCloseCursor.transaction_id` were removed.
    33+
    * trace: Added events `.EventFunctionStart` and `.EventFunctionFinish`.
    34+
    * trace: `EventServiceQuery.parameters` was replaced by `EventServiceQuery.sent` and
    35+
    `EventServiceQuery.received`.
    36+
    * trace: Added `EventSweepFinish.access`.
    37+
    * trace: Fixed several unregistered bugs in parser.
    38+
    39+
    Version 1.0.1
    40+
    =============
    41+
    42+
    * Build scheme changed to `PEP 517`.
    43+
    * Various changes to documentation and type hint adjustments.
    44+
    * trace: New `has_statement_free` parsing option indicating that parsed trace contains
    45+
    `FREE_STATEMENT` events.
    46+
    * trace: Adjustments to seen items cache management.
    47+
    48+
    Version 1.0.0
    49+
    =============
    50+
    51+
    Initial release.
    52+
    53+
    .. _releases: https://github.com/FirebirdSQL/python3-lib/releases
    54+
    .. _Dash: https://kapeli.com/dash
    55+
    .. _Zeal: https://zealdocs.org/

    ‎docs/firebird-lib.docset/Contents/Resources/Documents/_sources/index.txt

    Lines changed: 47 additions & 0 deletions
    Original file line numberDiff line numberDiff line change
    @@ -0,0 +1,47 @@
    1+
    ###############################
    2+
    The Python library for Firebird
    3+
    ###############################
    4+
    5+
    The `firebird-lib` package provides extensions to `firebird-driver`_ - an official Python driver for the open source relational database `Firebird`_ ®.
    6+
    7+
    This package provides modules for:
    8+
    9+
    - Work with Firebird database schema.
    10+
    - Work with Firebird monitoring tables.
    11+
    - Processing output from gstat Firebird utility.
    12+
    - Processing Firebird server log.
    13+
    - Processing output from Firebird server trace & audit sessions.
    14+
    15+
    .. note:: Requires Python 3.8+
    16+
    17+
    .. tip:: You can download docset for Dash_ (MacOS) or Zeal_ (Windows / Linux) documentation
    18+
    readers from releases_ at github.
    19+
    20+
    Content
    21+
    *******
    22+
    23+
    .. toctree::
    24+
    :maxdepth: 2
    25+
    :caption: Contents:
    26+
    27+
    usage-guide
    28+
    reference
    29+
    changelog
    30+
    license
    31+
    32+
    Library development is sponsored by IBPhoenix_.
    33+
    34+
    Indices and tables
    35+
    ******************
    36+
    37+
    * :ref:`genindex`
    38+
    * :ref:`modindex`
    39+
    40+
    .. _firebird-driver: https://pypi.org/project/firebird-driver/
    41+
    .. _Python: http://python.org
    42+
    .. _Firebird: http://www.firebirdsql.org
    43+
    .. _Firebird Project: http://www.firebirdsql.org
    44+
    .. _IBPhoenix: http://www.ibphoenix.com
    45+
    .. _releases: https://github.com/FirebirdSQL/python3-lib/releases
    46+
    .. _Dash: https://kapeli.com/dash
    47+
    .. _Zeal: https://zealdocs.org/

    ‎docs/firebird-lib.docset/Contents/Resources/Documents/_sources/license.txt

    Lines changed: 6 additions & 0 deletions
    Original file line numberDiff line numberDiff line change
    @@ -0,0 +1,6 @@
    1+
    #######
    2+
    License
    3+
    #######
    4+
    5+
    .. include:: ../LICENSE
    6+

    ‎docs/firebird-lib.docset/Contents/Resources/Documents/_sources/ref-gstat.txt

    Lines changed: 42 additions & 0 deletions
    Original file line numberDiff line numberDiff line change
    @@ -0,0 +1,42 @@
    1+
    .. module:: firebird.lib.gstat
    2+
    :synopsis: Module for work with Firebird gstat output
    3+
    4+
    ==================
    5+
    firebird.lib.gstat
    6+
    ==================
    7+
    8+
    Enums
    9+
    =====
    10+
    11+
    DbAttribute
    12+
    -----------
    13+
    .. autoclass:: DbAttribute
    14+
    :no-members:
    15+
    16+
    Dataclasses
    17+
    ===========
    18+
    19+
    FillDistribution
    20+
    ----------------
    21+
    .. autoclass:: FillDistribution
    22+
    :no-members:
    23+
    24+
    Encryption
    25+
    ----------
    26+
    .. autoclass:: Encryption
    27+
    :no-members:
    28+
    29+
    Classes
    30+
    =======
    31+
    32+
    StatDatabase
    33+
    ------------
    34+
    .. autoclass:: StatDatabase
    35+
    36+
    StatTable
    37+
    ---------
    38+
    .. autoclass:: StatTable
    39+
    40+
    StatIndex
    41+
    ---------
    42+
    .. autoclass:: StatIndex

    ‎docs/firebird-lib.docset/Contents/Resources/Documents/_sources/ref-log.txt

    Lines changed: 23 additions & 0 deletions
    Original file line numberDiff line numberDiff line change
    @@ -0,0 +1,23 @@
    1+
    .. module:: firebird.lib.log
    2+
    :synopsis: Module for parsing Firebird server log
    3+
    4+
    ================
    5+
    firebird.lib.log
    6+
    ================
    7+
    8+
    Module for parsing Firebird server log.
    9+
    10+
    Dataclasses
    11+
    ===========
    12+
    13+
    LogMessage
    14+
    ----------
    15+
    .. autoclass:: LogMessage
    16+
    17+
    Classes
    18+
    =======
    19+
    20+
    LogParser
    21+
    ---------
    22+
    .. autoclass:: LogParser
    23+

    ‎docs/firebird-lib.docset/Contents/Resources/Documents/_sources/ref-logmsgs.txt

    Lines changed: 33 additions & 0 deletions
    Original file line numberDiff line numberDiff line change
    @@ -0,0 +1,33 @@
    1+
    .. module:: firebird.lib.logmsgs
    2+
    :synopsis: Firebird log messages for Firebird log parser
    3+
    4+
    ====================
    5+
    firebird.lib.logmsgs
    6+
    ====================
    7+
    8+
    Firebird log messages for Firebird log parser
    9+
    10+
    Enums
    11+
    =====
    12+
    13+
    Severity
    14+
    --------
    15+
    .. autoclass:: Severity
    16+
    17+
    Facility
    18+
    --------
    19+
    .. autoclass:: Facility
    20+
    21+
    Dataclasses
    22+
    ===========
    23+
    24+
    MsgDesc
    25+
    -------
    26+
    .. autoclass:: MsgDesc
    27+
    28+
    Functions
    29+
    =========
    30+
    31+
    identify_msg
    32+
    ------------
    33+
    .. autofunction:: identify_msg

    ‎docs/firebird-lib.docset/Contents/Resources/Documents/_sources/ref-monitor.txt

    Lines changed: 77 additions & 0 deletions
    Original file line numberDiff line numberDiff line change
    @@ -0,0 +1,77 @@
    1+
    .. module:: firebird.lib.monitor
    2+
    :synopsis: Module for work with Firebird monitoring tables
    3+
    4+
    ====================
    5+
    firebird.lib.monitor
    6+
    ====================
    7+
    8+
    Enums
    9+
    =====
    10+
    11+
    ShutdownMode
    12+
    ------------
    13+
    .. autoclass:: ShutdownMode
    14+
    15+
    BackupState
    16+
    -----------
    17+
    .. autoclass:: BackupState
    18+
    19+
    State
    20+
    -----
    21+
    .. autoclass:: State
    22+
    23+
    IsolationMode
    24+
    -------------
    25+
    .. autoclass:: IsolationMode
    26+
    27+
    Group
    28+
    -----
    29+
    .. autoclass:: Group
    30+
    31+
    Security
    32+
    --------
    33+
    .. autoclass:: Security
    34+
    35+
    Classes
    36+
    =======
    37+
    38+
    Monitor
    39+
    -------
    40+
    .. autoclass:: Monitor
    41+
    42+
    InfoItem
    43+
    --------
    44+
    .. autoclass:: InfoItem
    45+
    46+
    DatabaseInfo
    47+
    ------------
    48+
    .. autoclass:: DatabaseInfo
    49+
    50+
    AttachmentInfo
    51+
    --------------
    52+
    .. autoclass:: AttachmentInfo
    53+
    54+
    TransactionInfo
    55+
    ---------------
    56+
    .. autoclass:: TransactionInfo
    57+
    58+
    StatementInfo
    59+
    -------------
    60+
    .. autoclass:: StatementInfo
    61+
    62+
    CallStackInfo
    63+
    -------------
    64+
    .. autoclass:: CallStackInfo
    65+
    66+
    IOStatsInfo
    67+
    -----------
    68+
    .. autoclass:: IOStatsInfo
    69+
    70+
    TableStatsInfo
    71+
    --------------
    72+
    .. autoclass:: TableStatsInfo
    73+
    74+
    ContextVariableInfo
    75+
    -------------------
    76+
    .. autoclass:: ContextVariableInfo
    77+

    0 commit comments

    Comments
     (0)
    0