← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/myisam/docs/index.rst

  • Committer: Daniel Nichter
  • Date: 2011-08-13 20:41:38 UTC
  • mto: This revision was merged to the branch mainline in revision 2413.
  • Revision ID: daniel@percona.com-20110813204138-stxa89ca1t7cg1uy
https://launchpad.net/bugs/793182
Skeleton documentation for all plugins, more complete docu for first half of plugins.
Clean up plugin.ini titles and descriptions.
Reformat and reorganize root index.
Change Administrative to Administration and remove empty files (logging, etc.)
Add, fix, and tag documentation for functions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/myisam/docs/index.rst
 
1
MyISAM Storage Engine
 
2
=====================
 
3
 
 
4
Default engine as of MySQL 3.23 with great performance.
 
5
 
 
6
.. _myisam_loading:
 
7
 
 
8
Loading
 
9
-------
 
10
 
 
11
This plugin is loaded by default, but it may need to be configured.  See
 
12
the plugin's :ref:`myisam_configuration` and
 
13
:ref:`myisam_variables`.
 
14
 
 
15
To stop the plugin from loading by default, start :program:`drizzled`
 
16
with::
 
17
 
 
18
   --plugin-remove=myisam
 
19
 
 
20
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
21
 
 
22
.. _myisam_configuration:
 
23
 
 
24
Configuration
 
25
-------------
 
26
 
 
27
These command line options configure the plugin when :program:`drizzled`
 
28
is started.  See :doc:`/configuration` for more information about specifying
 
29
command line options.
 
30
 
 
31
.. program:: drizzled
 
32
 
 
33
.. option:: --myisam.max-sort-file-size ARG
 
34
 
 
35
   :Default: INT32_MAX
 
36
   :Variable: :ref:`myisam_max_sort_file_size <myisam_max_sort_file_size>`
 
37
 
 
38
   Don't use the fast sort index method to created index if the temporary file would get bigger than this.
 
39
 
 
40
.. option:: --myisam.sort-buffer-size ARG
 
41
 
 
42
   :Default: 8192*1024
 
43
   :Variable: :ref:`myisam_sort_buffer_size <myisam_sort_buffer_size>`
 
44
 
 
45
   The buffer that is allocated when sorting the index when doing a REPAIR or when creating indexes with CREATE INDEX or ALTER TABLE.
 
46
 
 
47
.. _myisam_variables:
 
48
 
 
49
Variables
 
50
---------
 
51
 
 
52
These variables show the running configuration of the plugin.
 
53
See `variables` for more information about querying and setting variables.
 
54
 
 
55
.. _myisam_max_sort_file_size:
 
56
 
 
57
* ``myisam_max_sort_file_size``
 
58
 
 
59
   :Scope: Global
 
60
   :Dynamic: No
 
61
   :Option: :option:`--myisam.max-sort-file-size`
 
62
 
 
63
   Don't use the fast sort index method to created index if the temporary file would get bigger than this.
 
64
 
 
65
.. _myisam_sort_buffer_size:
 
66
 
 
67
* ``myisam_sort_buffer_size``
 
68
 
 
69
   :Scope: Global
 
70
   :Dynamic: No
 
71
   :Option: :option:`--myisam.sort-buffer-size`
 
72
 
 
73
   The buffer that is allocated when sorting the index when doing a REPAIR or when creating indexes with CREATE INDEX or ALTER TABLE.
 
74
 
 
75
.. _myisam_examples:
 
76
 
 
77
Examples
 
78
--------
 
79
 
 
80
Sorry, there are no examples for this plugin.
 
81
 
 
82
.. _myisam_authors:
 
83
 
 
84
Authors
 
85
-------
 
86
 
 
87
MySQL AB
 
88
 
 
89
.. _myisam_version:
 
90
 
 
91
Version
 
92
-------
 
93
 
 
94
This documentation applies to **myisam 2.0**.
 
95
 
 
96
To see which version of the plugin a Drizzle server is running, execute:
 
97
 
 
98
.. code-block:: mysql
 
99
 
 
100
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='myisam'
 
101