enableCompression()

名称

enableCompression - 修改集合的属性开启压缩功能。

语法

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

类别

Collection

描述

修改集合的属性开启压缩功能。

参数

  • options ( Object， 必填 )

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

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

    • "lzw"：使用 lzw 算法压缩。（默认值）
    • "snappy"：使用 snappy 算法压缩。格式：CompressionType : "lzw" | "snappy"

Note:

不显式设置 CompressionType 将默认把压缩算法修改为 "lzw"

返回值

成功：无。

失败：抛出异常。

错误

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

错误码错误类型可能的原因解决方法
-32SDB_OPTION_NOT_SUPPORT选项暂不支持检查当前集合属性，如果是分区集合不能修改与分区相关的属性。

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

版本

v2.10及以上版本。

示例

  • 创建一个普通集合，然后将该集合修改为 snappy 压缩
  1. > db.foo.createCL('bar')
  2. > db.foo.bar.enableCompression( { CompressionType: 'snappy' } )