awSQL/docs/docusaurus/build/assets/js/24da6c76.159e5a29.js

"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[294],{6421:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>c,default:()=>x,frontMatter:()=>t,metadata:()=>r,toc:()=>o});const r=JSON.parse('{"id":"classes/structure","title":"Structure","description":"Defines a new table structure for managing columns efficiently.","source":"@site/docs/classes/structure.md","sourceDirName":"classes","slug":"/classes/structure","permalink":"/awSQL/classes/structure","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":7,"frontMatter":{"sidebar_position":7},"sidebar":"defaultSidebar","previous":{"title":"Update","permalink":"/awSQL/classes/update"},"next":{"title":"CreateTable","permalink":"/awSQL/classes/create-table"}}');var d=n(4848),i=n(8453);const t={sidebar_position:7},c="Structure",l={},o=[{value:"Methods",id:"methods",level:2},{value:"constructor()",id:"constructor",level:3},{value:"get()",id:"get",level:3},{value:"drop()",id:"drop",level:3},{value:"Column Methods",id:"column-methods",level:2},{value:"String-Based Columns",id:"string-based-columns",level:3},{value:"Binary Data Columns",id:"binary-data-columns",level:3},{value:"Numeric Columns",id:"numeric-columns",level:3},{value:"Floating Point &amp; Decimal Columns",id:"floating-point--decimal-columns",level:3},{value:"Date &amp; Time Columns",id:"date--time-columns",level:3}];function h(e){const s={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(s.header,{children:(0,d.jsx)(s.h1,{id:"structure",children:"Structure"})}),"\n",(0,d.jsx)(s.p,{children:"Defines a new table structure for managing columns efficiently."}),"\n",(0,d.jsx)(s.hr,{}),"\n",(0,d.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,d.jsx)(s.hr,{}),"\n",(0,d.jsx)(s.h3,{id:"constructor",children:"constructor()"}),"\n",(0,d.jsxs)(s.p,{children:["\u2192 (",(0,d.jsx)(s.code,{children:"tableDescription"}),"? = ",(0,d.jsx)(s.strong,{children:"Array"}),"<",(0,d.jsx)(s.a,{href:"../typedefs/column-structure",children:"ColumnStructure"}),">) \u2192 ",(0,d.jsx)(s.code,{children:"this"})]}),"\n",(0,d.jsxs)(s.p,{children:["Create a new ",(0,d.jsx)(s.code,{children:"Structure"})," instance."]}),"\n",(0,d.jsx)(s.p,{children:(0,d.jsx)(s.strong,{children:"Parameters"})}),"\n",(0,d.jsxs)(s.table,{children:[(0,d.jsx)(s.thead,{children:(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.th,{children:"Parameter"}),(0,d.jsx)(s.th,{children:"Type"}),(0,d.jsx)(s.th,{children:"Description"})]})}),(0,d.jsx)(s.tbody,{children:(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"tableDescription"})," ",(0,d.jsx)(s.strong,{children:"optional"})]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.strong,{children:"Array"}),"<",(0,d.jsx)(s.a,{href:"../typedefs/column-structure",children:"ColumnStructure"}),">"]}),(0,d.jsxs)(s.td,{children:["A list of column structure objects defining table columns.",(0,d.jsx)("br",{}),(0,d.jsx)("br",{}),"A table description can be retrieved using the ",(0,d.jsx)(s.a,{href:"#get",children:"get()"})," method and later reloaded by passing it to the ",(0,d.jsx)(s.code,{children:"Structure"})," constructor."]})]})})]}),"\n",(0,d.jsx)(s.p,{children:(0,d.jsx)(s.strong,{children:"Returns"})}),"\n",(0,d.jsxs)(s.p,{children:["\u2192 ",(0,d.jsx)(s.code,{children:"this"})," - The instance of ",(0,d.jsx)(s.code,{children:"Structure"}),"."]}),"\n",(0,d.jsx)(s.hr,{}),"\n",(0,d.jsx)(s.h3,{id:"get",children:"get()"}),"\n",(0,d.jsxs)(s.p,{children:["\u2192 () \u2192 ",(0,d.jsx)(s.strong,{children:"Array"}),"<",(0,d.jsx)(s.a,{href:"../typedefs/column-structure",children:"ColumnStructure"}),">"]}),"\n",(0,d.jsxs)(s.p,{children:["Retrieves an array of all defined columns in the ",(0,d.jsx)(s.code,{children:"Structure"})," as ",(0,d.jsx)(s.a,{href:"../typedefs/column-structure",children:"ColumnStructure"})," objects."]}),"\n",(0,d.jsx)(s.p,{children:(0,d.jsx)(s.strong,{children:"Returns"})}),"\n",(0,d.jsxs)(s.p,{children:["\u2192 ",(0,d.jsx)(s.strong,{children:"Array"}),"<",(0,d.jsx)(s.a,{href:"../typedefs/column-structure",children:"ColumnStructure"}),"> - A list of defined columns."]}),"\n",(0,d.jsx)(s.hr,{}),"\n",(0,d.jsx)(s.h3,{id:"drop",children:"drop()"}),"\n",(0,d.jsxs)(s.p,{children:["\u2192 (",(0,d.jsx)(s.code,{children:"name"})," = ",(0,d.jsx)(s.strong,{children:"String"}),") \u2192 ",(0,d.jsx)(s.code,{children:"this"})]}),"\n",(0,d.jsx)(s.p,{children:"Removes a column from the structure."}),"\n",(0,d.jsx)(s.p,{children:(0,d.jsx)(s.strong,{children:"Parameters"})}),"\n",(0,d.jsxs)(s.table,{children:[(0,d.jsx)(s.thead,{children:(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.th,{children:"Parameter"}),(0,d.jsx)(s.th,{children:"Type"}),(0,d.jsx)(s.th,{children:"Description"})]})}),(0,d.jsx)(s.tbody,{children:(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.td,{children:(0,d.jsx)(s.code,{children:"name"})}),(0,d.jsx)(s.td,{children:(0,d.jsx)(s.strong,{children:"String"})}),(0,d.jsx)(s.td,{children:"The column name to remove."})]})})]}),"\n",(0,d.jsx)(s.p,{children:(0,d.jsx)(s.strong,{children:"Returns"})}),"\n",(0,d.jsxs)(s.p,{children:["\u2192 ",(0,d.jsx)(s.code,{children:"this"})]}),"\n",(0,d.jsx)(s.hr,{}),"\n",(0,d.jsx)(s.h2,{id:"column-methods",children:"Column Methods"}),"\n",(0,d.jsx)(s.p,{children:"Each of these methods adds a column of the specified type to the structure."}),"\n",(0,d.jsx)(s.hr,{}),"\n",(0,d.jsx)(s.h3,{id:"string-based-columns",children:"String-Based Columns"}),"\n",(0,d.jsxs)(s.table,{children:[(0,d.jsx)(s.thead,{children:(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.th,{children:"Method"}),(0,d.jsx)(s.th,{children:"Parameters"}),(0,d.jsx)(s.th,{children:"Description"})]})}),(0,d.jsxs)(s.tbody,{children:[(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["char(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"size"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"size"}),": (",(0,d.jsx)(s.em,{children:"0-255, default 1"}),")"]}),(0,d.jsx)(s.td,{children:"Adds a fixed-length character column."})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["varchar(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"size"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"size"}),": (",(0,d.jsx)(s.em,{children:"0-255, default 1"}),")"]}),(0,d.jsx)(s.td,{children:"Adds a variable-length character column."})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["tinytext(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsx)(s.td,{children:"-"}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"tinytext"})," column."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["text(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsx)(s.td,{children:"-"}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"text"})," column."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["mediumtext(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsx)(s.td,{children:"-"}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"mediumtext"})," column."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["longtext(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsx)(s.td,{children:"-"}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"longtext"})," column."]})]})]})]}),"\n",(0,d.jsx)(s.hr,{}),"\n",(0,d.jsx)(s.h3,{id:"binary-data-columns",children:"Binary Data Columns"}),"\n",(0,d.jsxs)(s.table,{children:[(0,d.jsx)(s.thead,{children:(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.th,{children:"Method"}),(0,d.jsx)(s.th,{children:"Parameters"}),(0,d.jsx)(s.th,{children:"Description"})]})}),(0,d.jsxs)(s.tbody,{children:[(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["binary(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"size"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"size"}),": (",(0,d.jsx)(s.em,{children:"1+, default 1"}),")"]}),(0,d.jsx)(s.td,{children:"Adds a binary column."})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["varbinary(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"size"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"size"}),": (",(0,d.jsx)(s.em,{children:"0+, default 1"}),")"]}),(0,d.jsx)(s.td,{children:"Adds a variable-length binary column."})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["tinyblob(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsx)(s.td,{children:"-"}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"tinyblob"})," column."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["blob(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"size"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"size"}),": (",(0,d.jsx)(s.em,{children:"0-65535, default 65535"}),")"]}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"blob"})," column."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["longblobl(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsx)(s.td,{children:"-"}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"longblob"})," column."]})]})]})]}),"\n",(0,d.jsx)(s.hr,{}),"\n",(0,d.jsxs)(s.table,{children:[(0,d.jsx)(s.thead,{children:(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.th,{children:"Method"}),(0,d.jsx)(s.th,{children:"Parameters"}),(0,d.jsx)(s.th,{children:"Description"})]})}),(0,d.jsxs)(s.tbody,{children:[(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["enum(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"vals"}),": ",(0,d.jsx)(s.strong,{children:"Array"}),"<",(0,d.jsx)(s.strong,{children:"String"}),">, ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"vals"}),": ",(0,d.jsx)(s.em,{children:"Array of allowed values"})]}),(0,d.jsxs)(s.td,{children:["Adds an ",(0,d.jsx)(s.code,{children:"enum"})," column with predefined values."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["set(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"vals"}),": ",(0,d.jsx)(s.strong,{children:"Array"}),"<",(0,d.jsx)(s.strong,{children:"String"}),">, ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"vals"}),": ",(0,d.jsx)(s.em,{children:"Array of allowed values"})]}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"set"})," column with multiple selectable values."]})]})]})]}),"\n",(0,d.jsx)(s.hr,{}),"\n",(0,d.jsx)(s.h3,{id:"numeric-columns",children:"Numeric Columns"}),"\n",(0,d.jsxs)(s.table,{children:[(0,d.jsx)(s.thead,{children:(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.th,{children:"Method"}),(0,d.jsx)(s.th,{children:"Parameters"}),(0,d.jsx)(s.th,{children:"Description"})]})}),(0,d.jsxs)(s.tbody,{children:[(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["bit(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"size"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"size"}),": (",(0,d.jsx)(s.em,{children:"1-64, default 1"}),")"]}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"bit"})," column."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["tinyint(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"size"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"size"}),": (",(0,d.jsx)(s.em,{children:"1-255, default 255"}),")"]}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"tinyint"})," column."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["bool(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsx)(s.td,{children:"-"}),(0,d.jsxs)(s.td,{children:["Alias for ",(0,d.jsx)(s.code,{children:"tinyint(1)"}),"."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["smallint(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"size"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"size"}),": (",(0,d.jsx)(s.em,{children:"1-255, default 255"}),")"]}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"smallint"})," column."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["mediumint(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"size"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"size"}),": (",(0,d.jsx)(s.em,{children:"1-255, default 255"}),")"]}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"mediumint"})," column."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["int(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"size"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"size"}),": (",(0,d.jsx)(s.em,{children:"1-255, default 255"}),")"]}),(0,d.jsxs)(s.td,{children:["Adds an ",(0,d.jsx)(s.code,{children:"int"})," column."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["bigint(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"size"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"size"}),": (",(0,d.jsx)(s.em,{children:"1-255, default 255"}),")"]}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"bigint"})," column."]})]})]})]}),"\n",(0,d.jsx)(s.hr,{}),"\n",(0,d.jsx)(s.h3,{id:"floating-point--decimal-columns",children:"Floating Point & Decimal Columns"}),"\n",(0,d.jsxs)(s.table,{children:[(0,d.jsx)(s.thead,{children:(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.th,{children:"Method"}),(0,d.jsx)(s.th,{children:"Parameters"}),(0,d.jsx)(s.th,{children:"Description"})]})}),(0,d.jsxs)(s.tbody,{children:[(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["float(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"p"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"p"}),": (",(0,d.jsx)(s.em,{children:"1-53, default 25"}),")"]}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"float"})," column."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["double(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"size"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"d"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"size"}),": (",(0,d.jsx)(s.em,{children:"1+, default 16"}),")",(0,d.jsx)("br",{}),(0,d.jsx)(s.code,{children:"d"}),": (",(0,d.jsx)(s.em,{children:"1+, default 8"}),")"]}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"double"})," dolumn."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["decimal(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"size"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"d"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"size"}),": (",(0,d.jsx)(s.em,{children:"1+, default 16"}),")",(0,d.jsx)("br",{}),(0,d.jsx)(s.code,{children:"d"}),": (",(0,d.jsx)(s.em,{children:"1+, default 8"}),")"]}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"decimal"})," column."]})]})]})]}),"\n",(0,d.jsx)(s.hr,{}),"\n",(0,d.jsx)(s.h3,{id:"date--time-columns",children:"Date & Time Columns"}),"\n",(0,d.jsxs)(s.table,{children:[(0,d.jsx)(s.thead,{children:(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.th,{children:"Method"}),(0,d.jsx)(s.th,{children:"Parameters"}),(0,d.jsx)(s.th,{children:"Description"})]})}),(0,d.jsxs)(s.tbody,{children:[(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["date(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsx)(s.td,{children:"-"}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"date"})," column."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["datetime(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"fsp"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"fsp"}),": (",(0,d.jsx)(s.em,{children:"0-6, default 0"}),")"]}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"datetime"})," column."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["timestamp(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"fsp"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"fsp"}),": (",(0,d.jsx)(s.em,{children:"0-6, default 0"}),")"]}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"timestamp"})," column."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["time(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"fsp"}),"?: ",(0,d.jsx)(s.strong,{children:"Number"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsxs)(s.td,{children:[(0,d.jsx)(s.code,{children:"fsp"}),": (",(0,d.jsx)(s.em,{children:"0-6, default 0"}),")"]}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"time"})," column."]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsxs)(s.td,{children:["year(",(0,d.jsx)(s.code,{children:"name"}),": ",(0,d.jsx)(s.strong,{children:"String"}),", ",(0,d.jsx)(s.code,{children:"options"}),"?: ",(0,d.jsx)(s.a,{href:"../typedefs/constraint-options",children:"ConstraintOptions"}),")"]}),(0,d.jsx)(s.td,{children:"-"}),(0,d.jsxs)(s.td,{children:["Adds a ",(0,d.jsx)(s.code,{children:"year"})," column."]})]})]})]}),"\n",(0,d.jsx)(s.hr,{})]})}function x(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,d.jsx)(s,{...e,children:(0,d.jsx)(h,{...e})}):h(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>t,x:()=>c});var r=n(6540);const d={},i=r.createContext(d);function t(e){const s=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:t(e.components),r.createElement(i.Provider,{value:s},e.children)}}}]);