.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Sympa::DatabaseDescription 3Sympa"
.TH Sympa::DatabaseDescription 3Sympa "2023-01-26" "6.2.70" "sympa 6.2.70"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Sympa::DatabaseDescription \- Definition of core database structure
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module keeps structure of database used by Sympa software.
.SS "Functions"
.IX Subsection "Functions"
.IP "full_db_struct ()" 4
.IX Item "full_db_struct ()"
\&\fIFunction\fR.
Returns a heshref containing definitions of all tables.
Each item has the name of table as key and definition as value.
.Sp
Each definition is hashref containing following keys:
.RS 4
.IP "fields" 4
.IX Item "fields"
See below.
.IP "doc" 4
.IX Item "doc"
Description of the table.
.IP "order" 4
.IX Item "order"
\&\s-1TBD.\s0
.RE
.RS 4
.Sp
\&\f(CW\*(C`fields\*(C'\fR item is hashref which may contain following items.
.IP "struct" 4
.IX Item "struct"
Column data types.  Definitions are based on MySQL.
Following types are recognized:
.RS 4
.IP "varchar(\fIlength\fR)" 4
.IX Item "varchar(length)"
Text with length up to \fIlength\fR.  \fIlength\fR must be lower than 2^16 \- 2.
.IP "\fBint\fR\|(1)" 4
.IX Item "int"
Boolean, 1 or 0.
.IP "int(11)" 4
.IX Item "int(11)"
Unix time.
.IP "int(\fIcols\fR)" 4
.IX Item "int(cols)"
Integer with columns up to \fIcols\fR, with its value from \-2^31 to 2^31 \- 1.
.IP "tinyint" 4
.IX Item "tinyint"
Integer, \-2^7 to 2^7 \- 1.
.IP "smallint" 4
.IX Item "smallint"
Integer, \-2^15 to 2^15 \- 1.
.IP "bigint" 4
.IX Item "bigint"
Integer, \-2^63 to 2^63 \- 1.
.IP "double" 4
.IX Item "double"
\&\s-1IEEE\s0 floating point number, 8 bytes.
.IP "enum" 4
.IX Item "enum"
Keyword with length up to 20 o.
.IP "text" 4
.IX Item "text"
Text with length up to 2000 o at minimum.
4000 o or longer is recommended.
.Sp
Note:
On Sympa 6.2.36 or earlier, required size was 500 o.
.IP "longtext" 4
.IX Item "longtext"
Text with length up to 2^32 \- 4 o.
.IP "datetime" 4
.IX Item "datetime"
Timestamp.
\&\fBDeprecated\fR as of Sympa 6.2.25b.3.
Use \f(CW\*(C`int(11)\*(C'\fR (Unix time) instead.
.IP "mediumblob" 4
.IX Item "mediumblob"
Binary data with length up to 2^24 \- 3 o.
.RE
.RS 4
.RE
.IP "doc" 4
.IX Item "doc"
Description of the field.
.IP "primary" 4
.IX Item "primary"
If this is true, primary key consists of this field.
.IP "not_null" 4
.IX Item "not_null"
If this is true, Null value is not allowed.
Note that fields included in primary key always don't allow Null value.
.RE
.RS 4
.RE
.IP "db_struct ()" 4
.IX Item "db_struct ()"
This function was \s-1OBSOLETED.\s0
.IP "not_null ()" 4
.IX Item "not_null ()"
\&\fIFunction\fR.
\&\s-1TBD.\s0
.IP "autoincrement ()" 4
.IX Item "autoincrement ()"
\&\fIFunction\fR.
\&\s-1TBD.\s0
.IP "primary ()" 4
.IX Item "primary ()"
\&\fIFunction\fR.
\&\s-1TBD.\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBsympa_database\fR\|(5),
Sympa::DatabaseManager.
.SH "HISTORY"
.IX Header "HISTORY"
Sympa::DatabaseDescription was introduced behind the veil on Sympa 6.1.
It began to be referred overtly as a part of Sympa Database Manager (\s-1SDM\s0) on
Sympa 6.2.