enableCompression()

名称

enableCompression - 开启集合的压缩功能或者修改集合的压缩算法

语法

db.collectionspace.collection.enableCompression([options])

类别

SdbCollection

描述

该函数用于开启集合的压缩功能或者修改集合的压缩算法。

参数

options ( object，选填 )

通过 options 参数可以修改压缩算法类型：

• CompressionType ( string )：集合的压缩算法类型，默认为 lzw 算法。其可选取值如下：

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

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

返回值

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

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

错误

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

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

版本

v2.10 及以上版本

示例

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

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