api/laravel/Database/Schema/Grammars/SQLiteGrammar.yaml
2024-09-26 02:03:21 -07:00

1042 lines
22 KiB
YAML

name: SQLiteGrammar
class_comment: null
dependencies:
- name: Connection
type: class
source: Illuminate\Database\Connection
- name: Expression
type: class
source: Illuminate\Database\Query\Expression
- name: Blueprint
type: class
source: Illuminate\Database\Schema\Blueprint
- name: IndexDefinition
type: class
source: Illuminate\Database\Schema\IndexDefinition
- name: Arr
type: class
source: Illuminate\Support\Arr
- name: Fluent
type: class
source: Illuminate\Support\Fluent
- name: RuntimeException
type: class
source: RuntimeException
properties:
- name: modifiers
visibility: protected
comment: '# * The possible column modifiers.
# *
# * @var string[]'
- name: serials
visibility: protected
comment: '# * The columns available as serials.
# *
# * @var string[]'
methods:
- name: getAlterCommands
visibility: public
parameters:
- name: connection
comment: "# * The possible column modifiers.\n# *\n# * @var string[]\n# */\n# protected\
\ $modifiers = ['Increment', 'Nullable', 'Default', 'Collate', 'VirtualAs', 'StoredAs'];\n\
# \n# /**\n# * The columns available as serials.\n# *\n# * @var string[]\n# */\n\
# protected $serials = ['bigInteger', 'integer', 'mediumInteger', 'smallInteger',\
\ 'tinyInteger'];\n# \n# /**\n# * Get the commands to be compiled on the alter\
\ command.\n# *\n# * @param \\Illuminate\\Database\\Connection $connection\n\
# * @return array"
- name: compileSqlCreateStatement
visibility: public
parameters:
- name: name
- name: type
default: '''table'''
comment: '# * Compile the query to determine the SQL text that describes the given
object.
# *
# * @param string $name
# * @param string $type
# * @return string'
- name: compileDbstatExists
visibility: public
parameters: []
comment: '# * Compile the query to determine if the dbstat table is available.
# *
# * @return string'
- name: compileTables
visibility: public
parameters:
- name: withSize
default: 'false'
comment: '# * Compile the query to determine the tables.
# *
# * @param bool $withSize
# * @return string'
- name: compileViews
visibility: public
parameters: []
comment: '# * Compile the query to determine the views.
# *
# * @return string'
- name: compileColumns
visibility: public
parameters:
- name: table
comment: '# * Compile the query to determine the columns.
# *
# * @param string $table
# * @return string'
- name: compileIndexes
visibility: public
parameters:
- name: table
comment: '# * Compile the query to determine the indexes.
# *
# * @param string $table
# * @return string'
- name: compileForeignKeys
visibility: public
parameters:
- name: table
comment: '# * Compile the query to determine the foreign keys.
# *
# * @param string $table
# * @return string'
- name: compileCreate
visibility: public
parameters:
- name: blueprint
- name: command
comment: '# * Compile a create table command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @return string'
- name: addForeignKeys
visibility: protected
parameters:
- name: foreignKeys
comment: '# * Get the foreign key syntax for a table creation statement.
# *
# * @param \Illuminate\Database\Schema\ForeignKeyDefinition[] $foreignKeys
# * @return string|null'
- name: getForeignKey
visibility: protected
parameters:
- name: foreign
comment: '# * Get the SQL for the foreign key.
# *
# * @param \Illuminate\Support\Fluent $foreign
# * @return string'
- name: addPrimaryKeys
visibility: protected
parameters:
- name: primary
comment: '# * Get the primary key syntax for a table creation statement.
# *
# * @param \Illuminate\Support\Fluent|null $primary
# * @return string|null'
- name: compileAdd
visibility: public
parameters:
- name: blueprint
- name: command
comment: '# * Compile alter table commands for adding columns.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @return string'
- name: compileAlter
visibility: public
parameters:
- name: blueprint
- name: command
- name: connection
comment: '# * Compile alter table command into a series of SQL statements.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @param \Illuminate\Database\Connection $connection
# * @return array|string
# *
# * @throws \RuntimeException'
- name: compileChange
visibility: public
parameters:
- name: blueprint
- name: command
- name: connection
comment: '# * Compile a change column command into a series of SQL statements.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @param \Illuminate\Database\Connection $connection
# * @return array|string
# *
# * @throws \RuntimeException'
- name: compilePrimary
visibility: public
parameters:
- name: blueprint
- name: command
comment: '# * Compile a primary key command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @return string'
- name: compileUnique
visibility: public
parameters:
- name: blueprint
- name: command
comment: '# * Compile a unique key command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @return string'
- name: compileIndex
visibility: public
parameters:
- name: blueprint
- name: command
comment: '# * Compile a plain index key command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @return string'
- name: compileSpatialIndex
visibility: public
parameters:
- name: blueprint
- name: command
comment: '# * Compile a spatial index key command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @return void
# *
# * @throws \RuntimeException'
- name: compileForeign
visibility: public
parameters:
- name: blueprint
- name: command
comment: '# * Compile a foreign key command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @return string|null'
- name: compileDrop
visibility: public
parameters:
- name: blueprint
- name: command
comment: '# * Compile a drop table command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @return string'
- name: compileDropIfExists
visibility: public
parameters:
- name: blueprint
- name: command
comment: '# * Compile a drop table (if exists) command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @return string'
- name: compileDropAllTables
visibility: public
parameters: []
comment: '# * Compile the SQL needed to drop all tables.
# *
# * @return string'
- name: compileDropAllViews
visibility: public
parameters: []
comment: '# * Compile the SQL needed to drop all views.
# *
# * @return string'
- name: compileRebuild
visibility: public
parameters: []
comment: '# * Compile the SQL needed to rebuild the database.
# *
# * @return string'
- name: compileDropColumn
visibility: public
parameters:
- name: blueprint
- name: command
- name: connection
comment: '# * Compile a drop column command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @param \Illuminate\Database\Connection $connection
# * @return array|null'
- name: compileDropPrimary
visibility: public
parameters:
- name: blueprint
- name: command
comment: '# * Compile a drop primary key command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @return string'
- name: compileDropUnique
visibility: public
parameters:
- name: blueprint
- name: command
comment: '# * Compile a drop unique key command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @return string'
- name: compileDropIndex
visibility: public
parameters:
- name: blueprint
- name: command
comment: '# * Compile a drop index command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @return string'
- name: compileDropSpatialIndex
visibility: public
parameters:
- name: blueprint
- name: command
comment: '# * Compile a drop spatial index command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @return void
# *
# * @throws \RuntimeException'
- name: compileDropForeign
visibility: public
parameters:
- name: blueprint
- name: command
comment: '# * Compile a drop foreign key command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @return array'
- name: compileRename
visibility: public
parameters:
- name: blueprint
- name: command
comment: '# * Compile a rename table command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @return string'
- name: compileRenameIndex
visibility: public
parameters:
- name: blueprint
- name: command
- name: connection
comment: '# * Compile a rename index command.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $command
# * @param \Illuminate\Database\Connection $connection
# * @return array
# *
# * @throws \RuntimeException'
- name: compileEnableForeignKeyConstraints
visibility: public
parameters: []
comment: '# * Compile the command to enable foreign key constraints.
# *
# * @return string'
- name: compileDisableForeignKeyConstraints
visibility: public
parameters: []
comment: '# * Compile the command to disable foreign key constraints.
# *
# * @return string'
- name: compileSetBusyTimeout
visibility: public
parameters:
- name: milliseconds
comment: '# * Compile the command to set the busy timeout.
# *
# * @param int $milliseconds
# * @return string'
- name: compileSetJournalMode
visibility: public
parameters:
- name: mode
comment: '# * Compile the command to set the journal mode.
# *
# * @param string $mode
# * @return string'
- name: compileSetSynchronous
visibility: public
parameters:
- name: mode
comment: '# * Compile the command to set the synchronous mode.
# *
# * @param string $mode
# * @return string'
- name: compileEnableWriteableSchema
visibility: public
parameters: []
comment: '# * Compile the SQL needed to enable a writable schema.
# *
# * @return string'
- name: compileDisableWriteableSchema
visibility: public
parameters: []
comment: '# * Compile the SQL needed to disable a writable schema.
# *
# * @return string'
- name: pragma
visibility: protected
parameters:
- name: name
- name: value
comment: '# * Get the SQL to set a PRAGMA value.
# *
# * @param string $name
# * @param mixed $value
# * @return string'
- name: typeChar
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a char type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeString
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a string type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeTinyText
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a tiny text type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeText
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a text type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeMediumText
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a medium text type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeLongText
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a long text type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeInteger
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for an integer type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeBigInteger
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a big integer type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeMediumInteger
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a medium integer type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeTinyInteger
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a tiny integer type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeSmallInteger
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a small integer type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeFloat
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a float type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeDouble
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a double type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeDecimal
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a decimal type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeBoolean
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a boolean type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeEnum
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for an enumeration type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeJson
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a json type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeJsonb
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a jsonb type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeDate
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a date type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeDateTime
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a date-time type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeDateTimeTz
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a date-time (with time zone) type.
# *
# * Note: "SQLite does not have a storage class set aside for storing dates and/or
times."
# *
# * @link https://www.sqlite.org/datatype3.html
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeTime
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a time type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeTimeTz
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a time (with time zone) type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeTimestamp
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a timestamp type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeTimestampTz
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a timestamp (with time zone) type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeYear
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a year type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeBinary
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a binary type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeUuid
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a uuid type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeIpAddress
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for an IP address type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeMacAddress
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a MAC address type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeGeometry
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a spatial Geometry type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeGeography
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a spatial Geography type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return string'
- name: typeComputed
visibility: protected
parameters:
- name: column
comment: '# * Create the column definition for a generated, computed column type.
# *
# * @param \Illuminate\Support\Fluent $column
# * @return void
# *
# * @throws \RuntimeException'
- name: modifyVirtualAs
visibility: protected
parameters:
- name: blueprint
- name: column
comment: '# * Get the SQL for a generated virtual column modifier.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $column
# * @return string|null'
- name: modifyStoredAs
visibility: protected
parameters:
- name: blueprint
- name: column
comment: '# * Get the SQL for a generated stored column modifier.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $column
# * @return string|null'
- name: modifyNullable
visibility: protected
parameters:
- name: blueprint
- name: column
comment: '# * Get the SQL for a nullable column modifier.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $column
# * @return string|null'
- name: modifyDefault
visibility: protected
parameters:
- name: blueprint
- name: column
comment: '# * Get the SQL for a default column modifier.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $column
# * @return string|null'
- name: modifyIncrement
visibility: protected
parameters:
- name: blueprint
- name: column
comment: '# * Get the SQL for an auto-increment column modifier.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $column
# * @return string|null'
- name: modifyCollate
visibility: protected
parameters:
- name: blueprint
- name: column
comment: '# * Get the SQL for a collation column modifier.
# *
# * @param \Illuminate\Database\Schema\Blueprint $blueprint
# * @param \Illuminate\Support\Fluent $column
# * @return string|null'
- name: wrapJsonSelector
visibility: protected
parameters:
- name: value
comment: '# * Wrap the given JSON selector.
# *
# * @param string $value
# * @return string'
traits:
- Illuminate\Database\Connection
- Illuminate\Database\Query\Expression
- Illuminate\Database\Schema\Blueprint
- Illuminate\Database\Schema\IndexDefinition
- Illuminate\Support\Arr
- Illuminate\Support\Fluent
- RuntimeException
interfaces: []