class Illuminate / Database / Schema / Grammars / PostgresGrammar
You are viewing an older version of the documentation. For the latest, please visit master documentation.

PostgresGrammar

Extends

Properties

protected

$transactions bool

If this Grammar supports schema changes wrapped in a transaction.

Default: true
protected

$modifiers string[]

The possible column modifiers.

Default: array
protected

$serials string[]

The columns available as serials.

Default: array
protected

$fluentCommands string[]

The commands to be executed outside of create or alter command.

Default: array

Methods

public

compileCreateDatabase ( $name , $connection ) : string

Compile a create database command.

Parameters

public

compileDropDatabaseIfExists ( $name ) : string

Compile a drop database if exists command.

Parameters

  • $name string
public

compileTableExists ( ) : string

Compile the query to determine if a table exists.

public

compileColumnListing ( ) : string

Compile the query to determine the list of columns.

public

compileCreate ( Blueprint $blueprint , Fluent $command ) : array

Compile a create table command.

Parameters

public

compileAdd ( Blueprint $blueprint , Fluent $command ) : string

Compile a column addition command.

Parameters

public

compileAutoIncrementStartingValues ( Blueprint $blueprint ) : array

Compile the auto-incrementing column starting values.

Parameters

public

compilePrimary ( Blueprint $blueprint , Fluent $command ) : string

Compile a primary key command.

Parameters

public

compileUnique ( Blueprint $blueprint , Fluent $command ) : string

Compile a unique key command.

Parameters

public

compileIndex ( Blueprint $blueprint , Fluent $command ) : string

Compile a plain index key command.

Parameters

public

compileFulltext ( Blueprint $blueprint , Fluent $command ) : string

Compile a fulltext index key command.

Parameters

public

compileSpatialIndex ( Blueprint $blueprint , Fluent $command ) : string

Compile a spatial index key command.

Parameters

public

compileForeign ( Blueprint $blueprint , Fluent $command ) : string

Compile a foreign key command.

Parameters

public

compileDrop ( Blueprint $blueprint , Fluent $command ) : string

Compile a drop table command.

Parameters

public

compileDropIfExists ( Blueprint $blueprint , Fluent $command ) : string

Compile a drop table (if exists) command.

Parameters

public

compileDropAllTables ( $tables ) : string

Compile the SQL needed to drop all tables.

Parameters

  • $tables array
public

compileDropAllViews ( $views ) : string

Compile the SQL needed to drop all views.

Parameters

  • $views array
public

compileDropAllTypes ( $types ) : string

Compile the SQL needed to drop all types.

Parameters

  • $types array
public

compileGetAllTables ( $schema ) : string

Compile the SQL needed to retrieve all table names.

Parameters

  • $schema string|array
public

compileGetAllViews ( $schema ) : string

Compile the SQL needed to retrieve all view names.

Parameters

  • $schema string|array
public

compileGetAllTypes ( ) : string

Compile the SQL needed to retrieve all type names.

public

compileDropColumn ( Blueprint $blueprint , Fluent $command ) : string

Compile a drop column command.

Parameters

public

compileDropPrimary ( Blueprint $blueprint , Fluent $command ) : string

Compile a drop primary key command.

Parameters

public

compileDropUnique ( Blueprint $blueprint , Fluent $command ) : string

Compile a drop unique key command.

Parameters

public

compileDropIndex ( Blueprint $blueprint , Fluent $command ) : string

Compile a drop index command.

Parameters

public

compileDropFullText ( Blueprint $blueprint , Fluent $command ) : string

Compile a drop fulltext index command.

Parameters

public

compileDropSpatialIndex ( Blueprint $blueprint , Fluent $command ) : string

Compile a drop spatial index command.

Parameters

public

compileDropForeign ( Blueprint $blueprint , Fluent $command ) : string

Compile a drop foreign key command.

Parameters

public

compileRename ( Blueprint $blueprint , Fluent $command ) : string

Compile a rename table command.

Parameters

public

compileRenameIndex ( Blueprint $blueprint , Fluent $command ) : string

Compile a rename index command.

Parameters

public

compileEnableForeignKeyConstraints ( ) : string

Compile the command to enable foreign key constraints.

public

compileDisableForeignKeyConstraints ( ) : string

Compile the command to disable foreign key constraints.

public

compileComment ( Blueprint $blueprint , Fluent $command ) : string

Compile a comment command.

Parameters

protected

typeChar ( Fluent $column ) : string

Create the column definition for a char type.

Parameters

protected

typeString ( Fluent $column ) : string

Create the column definition for a string type.

Parameters

protected

typeTinyText ( Fluent $column ) : string

Create the column definition for a tiny text type.

Parameters

protected

typeText ( Fluent $column ) : string

Create the column definition for a text type.

Parameters

protected

typeMediumText ( Fluent $column ) : string

Create the column definition for a medium text type.

Parameters

protected

typeLongText ( Fluent $column ) : string

Create the column definition for a long text type.

Parameters

protected

typeInteger ( Fluent $column ) : string

Create the column definition for an integer type.

Parameters

protected

typeBigInteger ( Fluent $column ) : string

Create the column definition for a big integer type.

Parameters

protected

typeMediumInteger ( Fluent $column ) : string

Create the column definition for a medium integer type.

Parameters

protected

typeTinyInteger ( Fluent $column ) : string

Create the column definition for a tiny integer type.

Parameters

protected

typeSmallInteger ( Fluent $column ) : string

Create the column definition for a small integer type.

Parameters

protected

generatableColumn ( $type , Fluent $column ) : string

Create the column definition for a generatable column.

Parameters

protected

typeFloat ( Fluent $column ) : string

Create the column definition for a float type.

Parameters

protected

typeDouble ( Fluent $column ) : string

Create the column definition for a double type.

Parameters

protected

typeReal ( Fluent $column ) : string

Create the column definition for a real type.

Parameters

protected

typeDecimal ( Fluent $column ) : string

Create the column definition for a decimal type.

Parameters

protected

typeBoolean ( Fluent $column ) : string

Create the column definition for a boolean type.

Parameters

protected

typeEnum ( Fluent $column ) : string

Create the column definition for an enumeration type.

Parameters

protected

typeJson ( Fluent $column ) : string

Create the column definition for a json type.

Parameters

protected

typeJsonb ( Fluent $column ) : string

Create the column definition for a jsonb type.

Parameters

protected

typeDate ( Fluent $column ) : string

Create the column definition for a date type.

Parameters

protected

typeDateTime ( Fluent $column ) : string

Create the column definition for a date-time type.

Parameters

protected

typeDateTimeTz ( Fluent $column ) : string

Create the column definition for a date-time (with time zone) type.

Parameters

protected

typeTime ( Fluent $column ) : string

Create the column definition for a time type.

Parameters

protected

typeTimeTz ( Fluent $column ) : string

Create the column definition for a time (with time zone) type.

Parameters

protected

typeTimestamp ( Fluent $column ) : string

Create the column definition for a timestamp type.

Parameters

protected

typeTimestampTz ( Fluent $column ) : string

Create the column definition for a timestamp (with time zone) type.

Parameters

protected

typeYear ( Fluent $column ) : string

Create the column definition for a year type.

Parameters

protected

typeBinary ( Fluent $column ) : string

Create the column definition for a binary type.

Parameters

protected

typeUuid ( Fluent $column ) : string

Create the column definition for a uuid type.

Parameters

protected

typeIpAddress ( Fluent $column ) : string

Create the column definition for an IP address type.

Parameters

protected

typeMacAddress ( Fluent $column ) : string

Create the column definition for a MAC address type.

Parameters

protected

typeGeometry ( Fluent $column ) : string

Create the column definition for a spatial Geometry type.

Parameters

protected

typePoint ( Fluent $column ) : string

Create the column definition for a spatial Point type.

Parameters

protected

typeLineString ( Fluent $column ) : string

Create the column definition for a spatial LineString type.

Parameters

protected

typePolygon ( Fluent $column ) : string

Create the column definition for a spatial Polygon type.

Parameters

protected

typeGeometryCollection ( Fluent $column ) : string

Create the column definition for a spatial GeometryCollection type.

Parameters

protected

typeMultiPoint ( Fluent $column ) : string

Create the column definition for a spatial MultiPoint type.

Parameters

public

typeMultiLineString ( Fluent $column ) : string

Create the column definition for a spatial MultiLineString type.

Parameters

protected

typeMultiPolygon ( Fluent $column ) : string

Create the column definition for a spatial MultiPolygon type.

Parameters

protected

typeMultiPolygonZ ( Fluent $column ) : string

Create the column definition for a spatial MultiPolygonZ type.

Parameters

private

formatPostGisType ( $type , Fluent $column ) : string

Format the column definition for a PostGIS spatial type.

Parameters

protected

modifyCollate ( Blueprint $blueprint , Fluent $column ) : string|null

Get the SQL for a collation column modifier.

Parameters

protected

modifyNullable ( Blueprint $blueprint , Fluent $column ) : string|null

Get the SQL for a nullable column modifier.

Parameters

protected

modifyDefault ( Blueprint $blueprint , Fluent $column ) : string|null

Get the SQL for a default column modifier.

Parameters

protected

modifyIncrement ( Blueprint $blueprint , Fluent $column ) : string|null

Get the SQL for an auto-increment column modifier.

Parameters

protected

modifyVirtualAs ( Blueprint $blueprint , Fluent $column ) : string|null

Get the SQL for a generated virtual column modifier.

Parameters

protected

modifyStoredAs ( Blueprint $blueprint , Fluent $column ) : string|null

Get the SQL for a generated stored column modifier.

Parameters