java.lang.Object
- com.mysql.cj.xdevapi.CollectionImpl

所有已实现的接口:: Collection, DatabaseObject

public class CollectionImpl
extends Object
implements Collection

嵌套类概要
- 从接口继承的嵌套类/接口 com.mysql.cj.xdevapi.DatabaseObject
  DatabaseObject.DbObjectStatus, DatabaseObject.DbObjectType

方法概要

所有方法实例方法具体方法
修饰符和类型	方法	说明
`AddStatement`	`add(DbDoc doc)`	Add a document in the form of a DbDoc.
`AddStatement`	`add(DbDoc... docs)`	Add a sequence of documents.
`AddStatement`	`add(String... jsonString)`	Add one or more documents.
`AddStatement`	`add(Map<String,?> doc)`	Add a document in the form of a Map.
`Result`	`addOrReplaceOne(String id, DbDoc doc)`	Adds the document to the collection.
`Result`	`addOrReplaceOne(String id, String jsonString)`	Adds the document to the collection.
`long`	`count()`	Query the number of documents in this collection.
`Result`	`createIndex(String indexName, DbDoc indexDefinition)`	Create a new statement defining the creation of an index on this collection.
`Result`	`createIndex(String indexName, String jsonIndexDefinition)`	Create a new statement defining the creation of an index on this collection.
`void`	`dropIndex(String indexName)`	Create a new statement defining the removal of an index on this collection.
`boolean`	`equals(Object other)`
`DatabaseObject.DbObjectStatus`	`existsInDatabase()`	Query the existence of this database object.
`FindStatement`	`find()`	Create a new find statement retrieving all documents in the collection.
`FindStatement`	`find(String searchCondition)`	Create a new find statement retrieving documents matching the given search condition.
`String`	`getName()`	Retrieve the name of the database object represented by the Java object.
`DbDoc`	`getOne(String id)`	Return the document with the given id.
`Schema`	`getSchema()`	Retrieve the schema owning this database object.
`Session`	`getSession()`	Retrieve the session owning the given schema object.
`int`	`hashCode()`
`ModifyStatement`	`modify(String searchCondition)`	Create a new modify statement affecting documents matching the given search condition.
`DbDoc`	`newDoc()`	Create a new document.
`RemoveStatement`	`remove(String searchCondition)`	Create a new removal statement affecting documents matching the given search condition.
`Result`	`removeOne(String id)`	Removes the document with the given id.
`Result`	`replaceOne(String id, DbDoc doc)`	Takes in a document object that will replace the matching document.
`Result`	`replaceOne(String id, String jsonString)`	Takes in a document object that will replace the matching document.
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 方法详细资料
  - getSession
```
public Session getSession()
```
    从接口复制的说明: DatabaseObject
    
    Retrieve the session owning the given schema object.
    
    指定者:
    
    getSession 在接口中 DatabaseObject
    
    返回:
    
    Session
  - getSchema
```
public Schema getSchema()
```
    从接口复制的说明: DatabaseObject
    
    Retrieve the schema owning this database object.
    
    指定者:
    
    getSchema 在接口中 DatabaseObject
    
    返回:
    
    Schema
  - getName
```
public String getName()
```
    从接口复制的说明: DatabaseObject
    
    Retrieve the name of the database object represented by the Java object.
    
    指定者:
    
    getName 在接口中 DatabaseObject
    
    返回:
    
    name
  - existsInDatabase
```
public DatabaseObject.DbObjectStatus existsInDatabase()
```
    从接口复制的说明: DatabaseObject
    
    Query the existence of this database object.
    
    指定者:
    
    existsInDatabase 在接口中 DatabaseObject
    
    返回:
    
    DatabaseObject.DbObjectStatus
  - add
```
public AddStatement add(Map<String,?> doc)
```
    从接口复制的说明: Collection
    
    Add a document in the form of a Map.
    
    指定者:
    
    add 在接口中 Collection
    
    参数:
    
    doc - map of key-value parameters representing the document fields
    
    返回:
    
    AddStatement
  - add
```
public AddStatement add(String... jsonString)
```
    从接口复制的说明: Collection
    
    Add one or more documents.
    
    指定者:
    
    add 在接口中 Collection
    
    参数:
    
    jsonString - one or more documents given as JSON strings
    
    返回:
    
    AddStatement
  - add
```
public AddStatement add(DbDoc doc)
```
    从接口复制的说明: Collection
    
    Add a document in the form of a DbDoc.
    
    指定者:
    
    add 在接口中 Collection
    
    参数:
    
    doc - DbDoc
    
    返回:
    
    AddStatement
  - add
```
public AddStatement add(DbDoc... docs)
```
    从接口复制的说明: Collection
    
    Add a sequence of documents.
    
    指定者:
    
    add 在接口中 Collection
    
    参数:
    
    docs - one or more documents given as DbDoc
    
    返回:
    
    AddStatement
  - find
```
public FindStatement find()
```
    从接口复制的说明: Collection
    
    Create a new find statement retrieving all documents in the collection.
    
    指定者:
    
    find 在接口中 Collection
    
    返回:
    
    FindStatement
  - find
```
public FindStatement find(String searchCondition)
```
    从接口复制的说明: Collection
    
    Create a new find statement retrieving documents matching the given search condition.
    
    指定者:
    
    find 在接口中 Collection
    
    参数:
    
    searchCondition - condition expression
    
    返回:
    
    FindStatement
  - modify
```
public ModifyStatement modify(String searchCondition)
```
    从接口复制的说明: Collection
    
    Create a new modify statement affecting documents matching the given search condition.
    
    指定者:
    
    modify 在接口中 Collection
    
    参数:
    
    searchCondition - condition expression
    
    返回:
    
    ModifyStatement
  - remove
```
public RemoveStatement remove(String searchCondition)
```
    从接口复制的说明: Collection
    
    Create a new removal statement affecting documents matching the given search condition.
    
    指定者:
    
    remove 在接口中 Collection
    
    参数:
    
    searchCondition - condition expression
    
    返回:
    
    RemoveStatement
  - createIndex
```
public Result createIndex(String indexName,
                          DbDoc indexDefinition)
```
    从接口复制的说明: Collection
    
    Create a new statement defining the creation of an index on this collection.
    Example: collection.createIndex("myIndex", "{\"fields\": [{\"field\": \"$.myGeoJsonField\", \"type\": \"GEOJSON\", \"required\": true, \"options\": 2, \"srid\": 4326}], \"type\":\"SPATIAL\"}");
    指定者:
    
    createIndex 在接口中 Collection
    
    参数:
    
    indexName - index name
    
    indexDefinition - JSON document with the following fields:
    
    fields: array of IndexField objects, each describing a single document member to be included in the index (see below)
    
    type: string, (optional) the type of index. One of INDEX or SPATIAL (case insensitive). Default is INDEX and may be omitted.
    
    where single IndexField description consists of the following fields:
    
    field: string, the full document path to the document member or field to be indexed
    
    type: string, one of the supported SQL column types to map the field into (see below for a list). For numeric types, the optional UNSIGNED keyword may follow. For the TEXT type, the length to consider for indexing may be added. Type descriptions are case insensitive.
    
    required: bool, (optional) true if the field is required to exist in the document. Defaults to false, except for GEOJSON where it defaults to true
    
    options: int, (optional) special option flags for use when decoding GEOJSON data
    
    srid: int, (optional) srid value for use when decoding GEOJSON data
    
    返回:
    
    Result
  - createIndex
```
public Result createIndex(String indexName,
                          String jsonIndexDefinition)
```
    从接口复制的说明: Collection
    
    Create a new statement defining the creation of an index on this collection.
    Example: collection.createIndex("myIndex", "{\"fields\": [{\"field\": \"$.myGeoJsonField\", \"type\": \"GEOJSON\", \"required\": true, \"options\": 2, \"srid\": 4326}], \"type\":\"SPATIAL\"}");
    指定者:
    
    createIndex 在接口中 Collection
    
    参数:
    
    indexName - index name
    
    jsonIndexDefinition - JSON document with the following fields:
    
    fields: array of IndexField objects, each describing a single document member to be included in the index (see below)
    
    type: string, (optional) the type of index. One of INDEX or SPATIAL. Default is INDEX and may be omitted.
    
    where single IndexField description consists of the following fields:
    
    field: string, the full document path to the document member or field to be indexed
    
    type: string, one of the supported SQL column types to map the field into (see below for a list). For numeric types, the optional UNSIGNED keyword may follow. For the TEXT type, the length to consider for indexing may be added.
    
    required: bool, (optional) true if the field is required to exist in the document. Defaults to false, except for GEOJSON where it defaults to true
    
    options: int, (optional) special option flags for use when decoding GEOJSON data
    
    srid: int, (optional) srid value for use when decoding GEOJSON data
    
    返回:
    
    Result
  - dropIndex
```
public void dropIndex(String indexName)
```
    从接口复制的说明: Collection
    
    Create a new statement defining the removal of an index on this collection.
    
    指定者:
    
    dropIndex 在接口中 Collection
    
    参数:
    
    indexName - index name
  - count
```
public long count()
```
    从接口复制的说明: Collection
    
    Query the number of documents in this collection.
    
    指定者:
    
    count 在接口中 Collection
    
    返回:
    
    The number of documents in this collection
  - newDoc
```
public DbDoc newDoc()
```
    从接口复制的说明: Collection
    
    Create a new document.
    
    指定者:
    
    newDoc 在接口中 Collection
    
    返回:
    
    DbDoc
  - equals
```
public boolean equals(Object other)
```
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - replaceOne
```
public Result replaceOne(String id,
                         DbDoc doc)
```
    从接口复制的说明: Collection
    
    Takes in a document object that will replace the matching document. If no matches are found, the function returns normally with no changes being made.
    
    指定者:
    
    replaceOne 在接口中 Collection
    
    参数:
    
    id - the document id of the document to be replaced
    
    doc - the new document, which may contain expressions. If document contains an _id value, it is ignored.
    
    返回:
    
    Result object, which will indicate the number of affected documents (1 or 0, if none)
  - replaceOne
```
public Result replaceOne(String id,
                         String jsonString)
```
    从接口复制的说明: Collection
    
    Takes in a document object that will replace the matching document. If no matches are found, the function returns normally with no changes being made.
    
    指定者:
    
    replaceOne 在接口中 Collection
    
    参数:
    
    id - the document id of the document to be replaced
    
    jsonString - the new document, given as JSON string, which may contain expressions. If document contains an _id value, it is ignored.
    
    返回:
    
    Result object, which will indicate the number of affected documents (1 or 0, if none)
  - addOrReplaceOne
```
public Result addOrReplaceOne(String id,
                              DbDoc doc)
```
    从接口复制的说明: Collection
    
    Adds the document to the collection. The following algorithm applies:
    
    指定者:
    
    addOrReplaceOne 在接口中 Collection
    
    参数:
    
    id - the document id of the document to be replaced
    
    doc - the new document, which may contain expressions. If doc contains an _id value and it does not match the given id then the error will be thrown.
    
    返回:
    
    Result object, which will indicate the number of affected documents (0 - if none, 1 - if added, 2 - if replaced)
  - addOrReplaceOne
```
public Result addOrReplaceOne(String id,
                              String jsonString)
```
    从接口复制的说明: Collection
    
    Adds the document to the collection. The following algorithm applies:
    
    指定者:
    
    addOrReplaceOne 在接口中 Collection
    
    参数:
    
    id - the document id of the document to be replaced
    
    jsonString - the new document, given as JSON string, which may contain expressions. If doc contains an _id value and it does not match the given id then the error will be thrown.
    
    返回:
    
    Result object, which will indicate the number of affected documents (0 - if none, 1 - if added, 2 - if replaced)
  - getOne
```
public DbDoc getOne(String id)
```
    从接口复制的说明: Collection
    
    Return the document with the given id.
    
    指定者:
    
    getOne 在接口中 Collection
    
    参数:
    
    id - the document id of the document to be retrieved
    
    返回:
    
    the document, or NULL if no match found
  - removeOne
```
public Result removeOne(String id)
```
    从接口复制的说明: Collection
    
    Removes the document with the given id.
    
    指定者:
    
    removeOne 在接口中 Collection
    
    参数:
    
    id - the document id of the document to be removed
    
    返回:
    
    Returns a Result object, which will indicate the number of removed documents (1 or 0, if none)

类 CollectionImpl

嵌套类概要

从接口继承的嵌套类/接口 com.mysql.cj.xdevapi.DatabaseObject

方法概要

从类继承的方法 java.lang.Object

方法详细资料

getSession

getSchema

getName

existsInDatabase

add

add

add

add

find

find

modify

remove

createIndex

createIndex

dropIndex

count

newDoc

equals

hashCode

toString

replaceOne

replaceOne

addOrReplaceOne

addOrReplaceOne

getOne

removeOne