platform/api/laravel/Database/Schema/PostgresBuilder.yaml
2024-09-02 10:44:11 -07:00

154 lines
2.8 KiB
YAML

name: PostgresBuilder
class_comment: null
dependencies:
- name: ParsesSearchPath
type: class
source: Illuminate\Database\Concerns\ParsesSearchPath
- name: InvalidArgumentException
type: class
source: InvalidArgumentException
properties: []
methods:
- name: createDatabase
visibility: public
parameters:
- name: name
comment: '# * Create a database in the schema.
# *
# * @param string $name
# * @return bool'
- name: dropDatabaseIfExists
visibility: public
parameters:
- name: name
comment: '# * Drop a database from the schema if the database exists.
# *
# * @param string $name
# * @return bool'
- name: hasTable
visibility: public
parameters:
- name: table
comment: '# * Determine if the given table exists.
# *
# * @param string $table
# * @return bool'
- name: hasView
visibility: public
parameters:
- name: view
comment: '# * Determine if the given view exists.
# *
# * @param string $view
# * @return bool'
- name: getTypes
visibility: public
parameters: []
comment: '# * Get the user-defined types that belong to the database.
# *
# * @return array'
- name: dropAllTables
visibility: public
parameters: []
comment: '# * Drop all tables from the database.
# *
# * @return void'
- name: dropAllViews
visibility: public
parameters: []
comment: '# * Drop all views from the database.
# *
# * @return void'
- name: dropAllTypes
visibility: public
parameters: []
comment: '# * Drop all types from the database.
# *
# * @return void'
- name: getColumns
visibility: public
parameters:
- name: table
comment: '# * Get the columns for a given table.
# *
# * @param string $table
# * @return array'
- name: getIndexes
visibility: public
parameters:
- name: table
comment: '# * Get the indexes for a given table.
# *
# * @param string $table
# * @return array'
- name: getForeignKeys
visibility: public
parameters:
- name: table
comment: '# * Get the foreign keys for a given table.
# *
# * @param string $table
# * @return array'
- name: getSchemas
visibility: protected
parameters: []
comment: '# * Get the schemas for the connection.
# *
# * @return array'
- name: parseSchemaAndTable
visibility: protected
parameters:
- name: reference
comment: '# * Parse the database object reference and extract the schema and table.
# *
# * @param string $reference
# * @return array'
- name: parseSearchPath
visibility: protected
parameters:
- name: searchPath
comment: '# * Parse the "search_path" configuration value into an array.
# *
# * @param string|array|null $searchPath
# * @return array'
traits:
- Illuminate\Database\Concerns\ParsesSearchPath
- InvalidArgumentException
interfaces: []