setAttributes()

    语法

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

    类别

    Collection

    修改集合的属性。

    参数

    • ( Object， 必填 )

    通过options参数可以修改集合属性，如指定集合的分区键，是否以压缩的形式插入数据等。可组合使用 options 的如下选项：

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

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

    • ShardingKey ( Object )：分区键。

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

      • "range"：范围分区。格式：ShardingType : "hash" | "range"

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

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

    格式：

    1. - 集合只能存在于一个数据组中
    • AutoSplit ( Bool )：标识新集合是否开启自动切分功能

    格式：AutoSplit : true | false

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

    • EnsureShardingIndex ( Bool )：标识是否创建分区索引

      • 默认值是 true
    • ( Bool )：标识集合是否开启数据压缩功能。

    格式：Compressed : true | false

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

      • "snappy"：使用 snappy 算法压缩。
      • "lzw"：使用 lzw 算法压缩。格式：CompressionType : "snappy" | "lzw"

    格式：StrictDataMode : true | false

    • AutoIncrement ( Object )：自增字段

    格式：AutoIncrement : <option>

    1. - option 中须加上 Field 属性，以标记要修改的字段。
    2. - 自增字段可以修改的属性有CurrentValue, Increment, StartValue, MinValue, MaxValue, CacheSize, AcquireSize, Cycled, Generated。属性具体功能请参考 [自增字段介绍](http://doc.sequoiadb.com/cn/SequoiaDB-cat_id-1541038339-edition_id-304)。

    Note:

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

    返回值

    成功：无。

    失败：抛出异常。

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

    当异常抛出时，可以通过getLastError()获取，或通过getLastErrMsg()获取错误信息。可以参考了解更多内容。

    版本

    示例

    • 创建一个普通集合，然后将该集合修改为分区集合。
    1. > db.foo.createCL('bar')
    2. > db.foo.bar.setAttributes( { ShardingKey: { a: 1 }, ShardingType: "hash" } )
    • 创建一个普通集合，然后将该集合修改为分区集合，并且自动切分：
    • 创建一个普通集合，然后将该集合修改为 snappy 压缩
    1. > db.foo.createCL('bar')
    2. > db.foo.bar.setAttributes( { CompressionType: 'snappy' } )
    • 创建一个有自增字段的集合，修改其自增起始值
    1. > db.foo.createCL( 'bar', { AutoIncrement: { Field: "studentID" } } )