PHP 클래스 yii\sphinx\Command

A command object is usually created by calling [[Connection::createCommand()]]. The SQL statement it represents can be set via the [[sql]] property. To execute a non-query SQL (such as INSERT, REPLACE, DELETE, UPDATE), call [[execute()]]. To execute a SQL statement that returns result data set (such as SELECT, CALL SNIPPETS, CALL KEYWORDS), use [[queryAll()]], [[queryOne()]], [[queryColumn()]], [[queryScalar()]], or [[query()]]. For example, ~~~ $articles = $connection->createCommand("SELECT * FROM idx_article WHERE MATCH('programming')")->queryAll(); ~~~ Command supports SQL statement preparation and parameter binding just as Command does. Command also supports building SQL statements by providing methods such as [[insert()]], Command::update, etc. For example, ~~~ $connection->createCommand()->update('idx_article', [ 'genre_id' => 15, 'author_id' => 157, ])->execute(); ~~~ To build SELECT SQL statements, please use Query and QueryBuilder instead.
부터: 2.0
저자: Paul Klimov ([email protected])
상속: extends yii\db\Command
파일 보기 프로젝트 열기: yiisoft/yii2-sphinx 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$db the Sphinx connection that this command is associated with.

공개 메소드들

메소드 설명
addColumn ( $table, $column, $type )
addForeignKey ( $name, $table, $columns, $refTable, $refColumns, $delete = null, $update = null )
addPrimaryKey ( $name, $table, $columns )
alterColumn ( $table, $column, $type )
batchInsert ( string $index, array $columns, array $rows ) Creates a batch INSERT command.
batchReplace ( string $index, array $columns, array $rows ) Creates a batch REPLACE command.
bindValue ( $name, $value, $dataType = null )
bindValues ( $values )
callKeywords ( string $index, string $text, boolean $fetchStatistic = false ) Returns tokenized and normalized forms of the keywords, and, optionally, keyword statistics.
callSnippets ( string $index, string | array $source, string $match, array $options = [] ) Builds a snippet from provided data and query, using specified index settings.
checkIntegrity ( $check = true, $schema = '', $table = '' )
createIndex ( $name, $table, $columns, $unique = false )
createTable ( $table, $columns, $options = null )
dropColumn ( $table, $column )
dropForeignKey ( $name, $table )
dropIndex ( $name, $table )
dropPrimaryKey ( $name, $table )
dropTable ( $table )
prepare ( $forRead = null )
renameColumn ( $table, $oldName, $newName )
renameTable ( $table, $newName )
replace ( string $index, array $columns ) Creates an REPLACE command.
resetSequence ( $table, $value = null )
truncateIndex ( string $index ) Creates a SQL command for truncating a runtime index.
truncateTable ( $table )
update ( string $index, array $columns, string | array $condition = '', array $params = [], array $options = [] ) Creates an UPDATE command.

비공개 메소드들

메소드 설명
parseFloatParams ( string $sql ) : string Parses given SQL replacing bound [[floatParams]] with their values.

메소드 상세

addColumn() 공개 메소드

public addColumn ( $table, $column, $type )

addForeignKey() 공개 메소드

public addForeignKey ( $name, $table, $columns, $refTable, $refColumns, $delete = null, $update = null )

addPrimaryKey() 공개 메소드

public addPrimaryKey ( $name, $table, $columns )

alterColumn() 공개 메소드

public alterColumn ( $table, $column, $type )

batchInsert() 공개 메소드

For example, php $connection->createCommand()->batchInsert('idx_user', ['name', 'age'], [ ['Tom', 30], ['Jane', 20], ['Linda', 25], ])->execute(); Note that the values in each row must match the corresponding column names.
public batchInsert ( string $index, array $columns, array $rows )
$index string the index that new rows will be inserted into.
$columns array the column names
$rows array the rows to be batch inserted into the index

batchReplace() 공개 메소드

For example, php $connection->createCommand()->batchReplace('idx_user', ['name', 'age'], [ ['Tom', 30], ['Jane', 20], ['Linda', 25], ])->execute(); Note that the values in each row must match the corresponding column names.
public batchReplace ( string $index, array $columns, array $rows )
$index string the index that new rows will be replaced.
$columns array the column names
$rows array the rows to be batch replaced in the index

bindValue() 공개 메소드

public bindValue ( $name, $value, $dataType = null )

bindValues() 공개 메소드

public bindValues ( $values )

callKeywords() 공개 메소드

Returns tokenized and normalized forms of the keywords, and, optionally, keyword statistics.
public callKeywords ( string $index, string $text, boolean $fetchStatistic = false )
$index string the name of the index from which to take the text processing settings
$text string the text to break down to keywords.
$fetchStatistic boolean whether to return document and hit occurrence statistics

callSnippets() 공개 메소드

Builds a snippet from provided data and query, using specified index settings.
public callSnippets ( string $index, string | array $source, string $match, array $options = [] )
$index string name of the index, from which to take the text processing settings.
$source string | array is the source data to extract a snippet from. It could be either a single string or array of strings.
$match string the full-text query to build snippets for.
$options array list of options in format: optionName => optionValue

checkIntegrity() 공개 메소드

public checkIntegrity ( $check = true, $schema = '', $table = '' )

createIndex() 공개 메소드

public createIndex ( $name, $table, $columns, $unique = false )

createTable() 공개 메소드

public createTable ( $table, $columns, $options = null )

dropColumn() 공개 메소드

public dropColumn ( $table, $column )

dropForeignKey() 공개 메소드

public dropForeignKey ( $name, $table )

dropIndex() 공개 메소드

public dropIndex ( $name, $table )

dropPrimaryKey() 공개 메소드

public dropPrimaryKey ( $name, $table )

dropTable() 공개 메소드

public dropTable ( $table )

prepare() 공개 메소드

public prepare ( $forRead = null )

renameColumn() 공개 메소드

public renameColumn ( $table, $oldName, $newName )

renameTable() 공개 메소드

public renameTable ( $table, $newName )

replace() 공개 메소드

For example, php $connection->createCommand()->replace('idx_user', [ 'name' => 'Sam', 'age' => 30, ])->execute(); The method will properly escape the column names, and bind the values to be replaced. Note that the created command is not executed until [[execute()]] is called.
public replace ( string $index, array $columns )
$index string the index that new rows will be replaced into.
$columns array the column data (name => value) to be replaced into the index.

resetSequence() 공개 메소드

public resetSequence ( $table, $value = null )

truncateIndex() 공개 메소드

Creates a SQL command for truncating a runtime index.
public truncateIndex ( string $index )
$index string the index to be truncated. The name will be properly quoted by the method.

truncateTable() 공개 메소드

public truncateTable ( $table )

update() 공개 메소드

For example, php $connection->createCommand()->update('user', ['status' => 1], 'age > 30')->execute(); The method will properly escape the column names and bind the values to be updated. Note that the created command is not executed until [[execute()]] is called.
public update ( string $index, array $columns, string | array $condition = '', array $params = [], array $options = [] )
$index string the index to be updated.
$columns array the column data (name => value) to be updated.
$condition string | array the condition that will be put in the WHERE part. Please refer to [[Query::where()]] on how to specify condition.
$params array the parameters to be bound to the command
$options array list of options in format: optionName => optionValue

프로퍼티 상세

$db 공개적으로 프로퍼티

the Sphinx connection that this command is associated with.
public $db