setAttributes()

名称

setAttributes - 修改集合的属性

语法

db.collectionspace.collection.setAttributes(<options>)

类别

SdbCollection

描述

该函数用于修改集合的属性。

参数

options ( object，必填 )

通过 options 参数可以修改集合属性：

• ReplSize ( number )：写操作需同步的副本数，其可选取值如下：

  • -1：表示写请求需同步到该复制组若干活跃的节点之后，数据库写操作才返回应答给客户端。
  • 0：表示写请求需同步到该复制组的所有节点之后，数据库写操作才返回应答给客户端。
  • 1 ~ 7：表示写请求需同步到该复制组指定数量个节点之后，数据库写操作才返回应答给客户端。

  格式：ReplSize: <number>

• ShardingKey ( object )：分区键，取值为 1 或 -1，表示正向或逆向排序

  • 已有的 ShardingKey 会被修改成新的 ShardingKey。
  • 集合只能存在于一个数据组中，或者集合为没有挂载子表的主表。

  格式：ShardingKey: {<字段1>: <1|-1>, [<字段2>: <1|-1>, ...]}

• ShardingType ( string )：分区方式，默认为 hash 分区，其可选取值如下：

  • "hash"：hash 分区
  • "range"：范围分区

  集合只能存在于一个数据组中。

  格式：ShardingType: "hash" | "range"

• Partition ( number )：分区数，仅当选择 hash 分区时填写，代表了 hash 分区的个数，其值必须是2的幂，范围在[2^3，2^20]

  集合只能存在于一个数据组中。

  格式：Partition: <分区数>

• AutoSplit ( boolean )：标识新集合是否开启自动切分功能，默认值为 false

  • 集合设置新的 hash 分区键后，可以使用该选项进行自动切分。
  • 不显式指定 AutoSplit 时，如果该集合修改前无指定 AutoSplit 且从属于某个非系统域，该域的 AutoSplit 参数将作用于此次设置。
  • 集合之前有指定 AutoSplit 为 false，需要显式设置 AutoSplit 为 true 进行自动切分。
  • AutoSplit 只能作用于 hash 分区键上。

  格式：AutoSplit: true | false

• EnsureShardingIndex ( boolean )：标识是否创建分区索引，默认值为 true

• Compressed ( boolean )：标识集合是否开启数据压缩功能

  如果设置 Compressed 为 true，而没有指定 CompressionType，则 CompressionType 为 "lzw"。

  格式：Compressed: true | false

• CompressionType ( string )：集合的压缩算法，"snappy" 或者 "lzw"

  • "snappy"：使用 snappy 算法压缩
  • "lzw"：使用 lzw 算法压缩

  格式：CompressionType: "snappy" | "lzw"

• StrictDataMode ( boolean )：标识对该集合的操作是否开启严格数据类型模式

  格式：StrictDataMode: true | false

• AutoIncrement ( object )：自增字段

  • option 中须加上 Field 属性，以标记要修改的字段。
  • 自增字段可以修改的属性有 CurrentValue, Increment, StartValue, MinValue, MaxValue, CacheSize, AcquireSize, Cycled, Generated。
    属性具体功能请参考自增字段介绍。
  • 修改属性后，字段值将可能不唯一。如需保证修改后值唯一，建议使用唯一索引。

  格式：AutoIncrement: <option>

  Note:

  • 各个选项的具体使用方式见 createCL()。
  • 分区集合不能修改与分区相关的属性，如 ShardingKey、Partition 等。
  • EnsureShardingIndex 和 AutoSplit 仅对当前该次操作生效，仅当修改分区属性，如 ShardingKey 等时有效。

• AutoIndexId ( Bool )：标识是否创建 $id 索引，默认值是 true

  格式：AutoIndexId: true | false

  Note:

  • 各个选项的具体使用方式见 db.collectionspace.createCL()。
  • 分区集合不能修改与分区相关的属性，如 ShardingKey、Partition 等。
  • EnsureShardingIndex 和 AutoSplit 仅对当前该次操作生效，仅当修改分区属性，如 ShardingKey 等时有效。

返回值

函数执行成功时，无返回值。

函数执行失败时，将抛异常并输出错误信息。

错误

setAttributes() 函数常见异常如下：

当异常抛出时，可以通过 getLastErrMsg() 获取错误信息或通过 getLastError() 获取错误码。更多错误处理可以参考常见错误处理指南。

版本

v2.10 及以上版本

示例

1. 创建一个普通集合，然后将该集合修改为分区集合。

   > db.sample.createCL('employee')
   > db.sample.employee.setAttributes({ShardingKey: {a: 1}, ShardingType: "hash"})

2. 创建一个普通集合，然后将该集合修改为分区集合，并且自动切分：

   > db.sample.createCL('employee')
   > db.sample.employee.setAttributes({ShardingKey: {a: 1}, ShardingType: "hash", AutoSplit: true})

3. 创建一个普通集合，然后将该集合修改为 snappy 压缩

   > db.sample.createCL('employee')
   > db.sample.employee.setAttributes({CompressionType: 'snappy'})

4. 创建一个有自增字段的集合，修改其自增起始值

   > db.sample.createCL('employee', {AutoIncrement: {Field: "studentID"}})
   > db.sample.employee.setAttributes({AutoIncrement: {Field: "studentID", StartValue: 2017140000}})