alter()

名称

alter - 修改集合空间的属性

语法

db.collectionspace.alter(<options>)

类别

SdbCS

描述

该函数用于修改集合空间的属性，更多内容可参考 setAttributes()。

参数

options ( object，必填 )

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

• PageSize ( number )：数据页大小，单位为字节

  • PageSize 只能选填 0、4096、8192、16384、32768、65536 之一
  • PageSize 为 0 时，即默认值 65536
  • 修改时不能有数据

  格式：PageSize: <number>

• LobPageSize ( number )：LOB 数据页大小，单位为字节

  • LobPageSize 只能选填 0、4096、8192、16384、32768、65536、131072、262144、524288 之一
  • LobPageSize 为 0 时，即默认值 262144
  • 修改时不能有 LOB 数据

  格式：LobPageSize: <number>

• Domain ( string )：所属域

  • 集合空间的数据必须分布在新指定域的组上

  格式：Domain: <domain>

返回值

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

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

错误

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

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

版本

v2.10 及以上版本

示例

• 创建一个集合空间，数据页大小为 4096，然后将该集合空间的数据页大小修改为 8192

   > db.createCS('sample', {PageSize: 4096})
   > db.sample.alter({PageSize: 8192})

• 创建一个集合空间，然后为该集合空间指定一个域

  > db.createCS('sample')
  > db.sample.alter({Domain: 'domain'})