\think\db\connectorMongo

Mongo数据库驱动

Summary

Methods

Properties

Constants

__construct()
getQueryClass()
getBuilder()
getBuilderClass()
connect()
getMongo()
db()
cursor()
getCursor()
query()
execute()
command()
mongoLog()
getLastSql()
close()
replicaSetConnect()
insert()
getLastInsID()
insertAll()
update()
delete()
select()
find()
value()
column()
cmd()
getTableFields()
transaction()
startTrans()
commit()
rollback()
getSession()

No public properties found

No constants found

getResult()
convertObjectID()
initConnect()
multiConnect()
setLastSession()

$dbName
$typeMap
$mongo
$cursor
$session_uuid
$sessions
$config

N/A

buildUrl()

No private properties found

N/A

File: vendor/topthink/think-orm/src/db/connector/Mongo.php
Package: Default
Class hierarchy: \think\db\Connection

\think\db\connector\Mongo
Implements: \think\db\ConnectionInterface

Properties

$dbName

$dbName :

Type

$typeMap

$typeMap :

Type

$mongo

$mongo :

Type

$cursor

$cursor :

Type

$session_uuid

$session_uuid :

Type

$sessions

$sessions :

Type

$config

$config :

Type

Methods

__construct()

__construct(array  $config = array())

架构函数读取数据库配置信息

Parameters

array

$config

数据库配置数组

getQueryClass()

getQueryClass() : string

获取当前连接器类对应的Query类

Returns

string

getBuilder()

getBuilder() : \think\db\builder\Mongo

获取当前的builder实例对象

Returns

\think\db\builder\Mongo

getBuilderClass()

getBuilderClass() : string

获取当前连接器类对应的Builder类

Returns

string

connect()

connect(array  $config = array(), integer  $linkNum) : \MongoDB\Driver\Manager

连接数据库方法

Parameters

array	$config	连接参数
integer	$linkNum	连接序号

Throws

\MongoDB\Driver\Exception\InvalidArgumentException
\MongoDB\Driver\Exception\RuntimeException

Returns

\MongoDB\Driver\Manager

getMongo()

getMongo() : \MongoDB\Driver\Manager|null

获取Mongo Manager对象

Returns

\MongoDB\Driver\Manager|null

db()

db(string  $db = null)

设置/获取当前操作的database

Parameters

string

$db

Throws

\think\db\exception\DbException

cursor()

cursor(\think\db\BaseQuery  $query) : \MongoDB\Driver\Cursor

执行查询但只返回Cursor对象

Parameters

\think\db\BaseQuery

$query

查询对象

Returns

\MongoDB\Driver\Cursor

getCursor()

getCursor(\think\db\BaseQuery  $query, \MongoDB\Driver\Query|\Closure  $mongoQuery, boolean  $master = false) : \MongoDB\Driver\Cursor

执行查询并返回Cursor对象

Parameters

\think\db\BaseQuery	$query	查询对象
\MongoDB\Driver\Query\|\Closure	$mongoQuery	Mongo查询对象
boolean	$master	是否主库操作

Throws

\MongoDB\Driver\Exception\AuthenticationException
\MongoDB\Driver\Exception\InvalidArgumentException
\MongoDB\Driver\Exception\ConnectionException
\MongoDB\Driver\Exception\RuntimeException

Returns

\MongoDB\Driver\Cursor

query()

query(\think\db\BaseQuery  $query, \MongoDB\Driver\Query|\Closure  $mongoQuery) : array

执行查询

Parameters

\think\db\BaseQuery	$query	查询对象
\MongoDB\Driver\Query\|\Closure	$mongoQuery	Mongo查询对象

Throws

\MongoDB\Driver\Exception\AuthenticationException
\MongoDB\Driver\Exception\InvalidArgumentException
\MongoDB\Driver\Exception\ConnectionException
\MongoDB\Driver\Exception\RuntimeException

Returns

array

execute()

execute(\think\db\BaseQuery  $query, \MongoDB\Driver\BulkWrite  $bulk) : \think\db\connector\WriteResult

执行写操作

Parameters

\think\db\BaseQuery	$query
\MongoDB\Driver\BulkWrite	$bulk

Throws

\MongoDB\Driver\Exception\AuthenticationException
\MongoDB\Driver\Exception\InvalidArgumentException
\MongoDB\Driver\Exception\ConnectionException
\MongoDB\Driver\Exception\RuntimeException
\MongoDB\Driver\Exception\BulkWriteException

Returns

\think\db\connector\WriteResult

command()

command(\MongoDB\Driver\Command  $command, string  $dbName = '', \MongoDB\Driver\ReadPreference  $readPreference = null, string|array  $typeMap = null, boolean  $master = false) : array

执行指令

Parameters

\MongoDB\Driver\Command	$command	指令
string	$dbName	当前数据库名
\MongoDB\Driver\ReadPreference	$readPreference	readPreference
string\|array	$typeMap	指定返回的typeMap
boolean	$master	是否主库操作

Throws

\MongoDB\Driver\Exception\AuthenticationException
\MongoDB\Driver\Exception\InvalidArgumentException
\MongoDB\Driver\Exception\ConnectionException
\MongoDB\Driver\Exception\RuntimeException

Returns

array

mongoLog()

mongoLog(string  $type, mixed  $data, array  $options = array()) : void

数据库日志记录（仅供参考）

Parameters

string	$type	类型
mixed	$data	数据
array	$options	参数

getLastSql()

getLastSql() : string

获取最近执行的指令

Returns

string

close()

close() : $this

关闭数据库

Returns

$this

replicaSetConnect()

replicaSetConnect() : \MongoDB\Driver\Manager

创建基于复制集的连接

Returns

\MongoDB\Driver\Manager

insert()

insert(\think\db\BaseQuery  $query, boolean  $getLastInsID = false) : mixed

插入记录

Parameters

\think\db\BaseQuery	$query	查询对象
boolean	$getLastInsID	返回自增主键

Throws

\MongoDB\Driver\Exception\AuthenticationException
\MongoDB\Driver\Exception\InvalidArgumentException
\MongoDB\Driver\Exception\ConnectionException
\MongoDB\Driver\Exception\RuntimeException
\MongoDB\Driver\Exception\BulkWriteException

Returns

mixed

getLastInsID()

getLastInsID(\think\db\BaseQuery  $query) : mixed

获取最近插入的ID

Parameters

\think\db\BaseQuery

$query

查询对象

Returns

mixed

insertAll()

insertAll(\think\db\BaseQuery  $query, array  $dataSet = array()) : integer

批量插入记录

Parameters

\think\db\BaseQuery	$query	查询对象
array	$dataSet	数据集

Throws

\MongoDB\Driver\Exception\AuthenticationException
\MongoDB\Driver\Exception\InvalidArgumentException
\MongoDB\Driver\Exception\ConnectionException
\MongoDB\Driver\Exception\RuntimeException
\MongoDB\Driver\Exception\BulkWriteException

Returns

integer

update()

update(\think\db\BaseQuery  $query) : integer

更新记录

Parameters

\think\db\BaseQuery

$query

查询对象

Throws

\think\db\exception\DbException
\MongoDB\Driver\Exception\AuthenticationException
\MongoDB\Driver\Exception\InvalidArgumentException
\MongoDB\Driver\Exception\ConnectionException
\MongoDB\Driver\Exception\RuntimeException
\MongoDB\Driver\Exception\BulkWriteException

Returns

integer

delete()

delete(\think\db\BaseQuery  $query) : integer

删除记录

Parameters

\think\db\BaseQuery

$query

查询对象

Throws

\think\db\exception\DbException
\MongoDB\Driver\Exception\AuthenticationException
\MongoDB\Driver\Exception\InvalidArgumentException
\MongoDB\Driver\Exception\ConnectionException
\MongoDB\Driver\Exception\RuntimeException
\MongoDB\Driver\Exception\BulkWriteException

Returns

integer

select()

select(\think\db\BaseQuery  $query) : array

查找记录

Parameters

\think\db\BaseQuery

$query

查询对象

Throws

\think\db\connector\ModelNotFoundException
\think\db\connector\DataNotFoundException
\MongoDB\Driver\Exception\AuthenticationException
\MongoDB\Driver\Exception\InvalidArgumentException
\MongoDB\Driver\Exception\ConnectionException
\MongoDB\Driver\Exception\RuntimeException

Returns

array

find()

find(\think\db\BaseQuery  $query) : array

查找单条记录

Parameters

\think\db\BaseQuery

$query

查询对象

Throws

\think\db\connector\ModelNotFoundException
\think\db\connector\DataNotFoundException
\MongoDB\Driver\Exception\AuthenticationException
\MongoDB\Driver\Exception\InvalidArgumentException
\MongoDB\Driver\Exception\ConnectionException
\MongoDB\Driver\Exception\RuntimeException

Returns

array

value()

value(\think\db\BaseQuery  $query, string  $field, mixed  $default = null) : mixed

得到某个字段的值

Parameters

\think\db\BaseQuery	$query	查询对象
string	$field	字段名
mixed	$default	默认值

Returns

mixed

column()

column(\think\db\BaseQuery  $query, string  $field, string  $key = '') : array

得到某个列的数组

Parameters

\think\db\BaseQuery	$query	查询对象
string	$field	字段名多个字段用逗号分隔
string	$key	索引

Returns

array

cmd()

cmd(\think\db\BaseQuery  $query, string|array|object  $command, mixed  $extra = null, string  $db = '') : array

执行command

Parameters

\think\db\BaseQuery	$query	查询对象
string\|array\|object	$command	指令
mixed	$extra	额外参数
string	$db	数据库名

Returns

array

getTableFields()

getTableFields(mixed  $tableName) : array

获取数据库字段

Parameters

mixed

$tableName

数据表名

Returns

array

transaction()

transaction(callable  $callback) : mixed

执行数据库事务

Parameters

callable

$callback

数据操作方法回调

Throws

\think\db\connector\PDOException
\Exception
\Throwable

Returns

mixed

startTrans()

startTrans() : void

启动事务

Throws

\PDOException
\Exception

commit()

commit() : void

用于非自动提交状态下面的查询提交

Throws

\think\db\connector\PDOException

rollback()

rollback() : void

事务回滚

Throws

\think\db\connector\PDOException

getSession()

getSession() : \MongoDB\Driver\Session|null

获取当前会话

Returns

\MongoDB\Driver\Session|null

Inherited from: \think\db\connector\Mongo