snapshot()

语法

db.snapshot( <snapType>, [cond], [sel], [sort] )

db.snapshot( <snapType>, [SdbSnapshotOption] )

枚举快照，快照是一种得到当前系统状态的命令。查看更多有关快照信息

参数描述

参数名参数类型描述是否必填
snapType枚举快照类型。是
condJson 对象设置匹配条件以及命令位置参数。否
selJson 对象选择返回字段名。为 null 时，返回所有的字段名。否
sortJson 对象对返回的记录按选定的字段排序。1为升序；-1为降序。否
SdbSnapshotOptionJson 对象使用一个对象来指定快照查询参数，使用方法请参考 SdbSnapshotOption否

Note:

  • snapType 字段的值请参考 快照类型。
  • sel 参数是一个json结构，如：{字段名:字段值}，字段值一般指定为空串。sel中指定的字段名在记录中存在，设置字段值不生效；不存在则返回sel中指定的字段名和字段值。
  • 记录中字段值类型为数组，我们可以在sel中指定该字段名，用"."操作符加上双引号("")来引用数组元素。

返回值

返回游标对象，出错抛异常，并输出错误信息，可以通过getLastErrMsg()获取错误信息或通过getLastError()获取错误码。关于错误处理可以参考常见错误处理指南。

错误

常见错误可参考错误码。

示例

  • 指定 snapType 的值为 SDB_SNAP_CONTEXTS：
  1. > db.snapshot( SDB_SNAP_CONTEXTS )
  2. {
  3.   "SessionID": "vmsvr1-cent-x64-1:11820:22",
  4.   "Contexts": [
  5.     {
  6.       "ContextID": 8,
  7.       "Type": "DUMP",
  8.       "Description": "BufferSize:0",
  9.       "DataRead": 0,
  10.       "IndexRead": 0,
  11.       "QueryTimeSpent": 0,
  12.       "StartTimestamp": "2013-12-28-16.07.59.146399"
  13.     }
  14.   ]
  15. }
  16. {
  17.   "SessionID": "vmsvr1-cent-x64-1:11830:22",
  18.   "Contexts": [
  19.     {
  20.       "ContextID": 6,
  21.       "Type": "DUMP",
  22.       "Description": "BufferSize:0",
  23.       "DataRead": 0,
  24.       "IndexRead": 0,
  25.       "QueryTimeSpent": 0,
  26.       "StartTimestamp": "2013-12-28-16.07.59.147576"
  27.     }
  28.   ]
  29. }
  30. {
  31.   "SessionID": "vmsvr1-cent-x64-1:11840:23",
  32.   "Contexts": [
  33.     {
  34.       "ContextID": 7,
  35.       "Type": "DUMP",
  36.       "Description": "BufferSize:0",
  37.       "DataRead": 0,
  38.       "IndexRead": 0,
  39.       "QueryTimeSpent": 0,
  40.       "StartTimestamp": "2013-12-28-16.07.59.148603"
  41.     }
  42.   ]
  43. }
  • 通过组名或组 ID 查询某个分区组的快照信息，如：
  1. > db.snapshot( SDB_SNAP_CONTEXTS, { GroupName:'data1' } )
  2. > db.snapshot(SDB_SNAP_CONTEXTS,{GroupID:1000})
  3. {
  4.   "SessionID": "vmsvr1-cent-x64-1:11820:22",
  5.   "Contexts": [
  6.     {
  7.       "ContextID": 11,
  8.       "Type": "DUMP",
  9.       "Description": "BufferSize:0",
  10.       "DataRead": 0,
  11.       "IndexRead": 0,
  12.       "QueryTimeSpent": 0,
  13.       "StartTimestamp": "2013-12-28-16.13.57.864245"
  14.     }
  15.   ]
  16. }
  17. {
  18.   "SessionID": "vmsvr1-cent-x64-1:11840:23",
  19.   "Contexts": [
  20.     {
  21.       "ContextID": 10,
  22.       "Type": "DUMP",
  23.       "Description": "BufferSize:0",
  24.       "DataRead": 0,
  25.       "IndexRead": 0,
  26.       "QueryTimeSpent": 0,
  27.       "StartTimestamp": "2013-12-28-16.13.57.865103"
  28.     }
  29.   ]
  30. }
  • 通过“组名+主机名+服务名”或“组 ID+节点 ID”查询某个节点的快照信息，如：
  1. > db.snapshot( SDB_SNAP_CONTEXTS, { GroupName: 'data1', HostName: "vmsvr1-cent-x64-1", svcname: "11820" } )
  2. > db.snapshot(SDB_SNAP_CONTEXTS,{GroupID:1000,NodeID:1001})
  3. {
  4.   "SessionID": "vmsvr1-cent-x64-1:11820:22",
  5.   "Contexts": [
  6.     {
  7.       "ContextID": 11,
  8.       "Type": "DUMP",
  9.       "Description": "BufferSize:0",
  10.       "DataRead": 0,
  11.       "IndexRead": 0,
  12.       "QueryTimeSpent": 0,
  13.       "StartTimestamp": "2013-12-28-16.13.57.864245"
  14.     }
  15.   ]
  16. }
  • 通过“主机名+服务名”查询某个节点的快照信息，如：
  1. > db.snapshot( SDB_SNAP_CONTEXTS, { HostName: "ubuntu-200-043", svcname: "11820" } )
  2. {
  3.   "NodeName": "ubuntu-200-043:11820",
  4.   "SessionID": 18,
  5.   "Contexts": [
  6.     {
  7.       "ContextID": 31,
  8.       "Type": "DUMP",
  9.       "Description": "IsOpened:1,HitEnd:0,BufferSize:0",
  10.       "DataRead": 0,
  11.       "IndexRead": 0,
  12.       "QueryTimeSpent": 0,
  13.       "StartTimestamp": "2016-10-27-17.53.45.042061"
  14.     }
  15.   ]
  16. }
  • 返回未在coord聚集前的原始数据：
  1. > db.snapshot( SDB_SNAP_DATABASE, { RawData: true } ,{ NodeName: null, GroupName: null, TotalDataRead: null } )
  2. {
  3.   "NodeName": "ubuntu1604-yt:30000",
  4.   "GroupName": "SYSCatalogGroup",
  5.   "TotalDataRead": 276511
  6. }
  7. {
  8.   "NodeName": "ubuntu1604-yt:20000",
  9.   "GroupName": "db1",
  10.   "TotalDataRead": 16542209
  11. }
  12. {
  13.   "NodeName": "ubuntu1604-yt:40000",
  14.   "GroupName": "db2",
  15.   "TotalDataRead": 959
  16. }
  17. Return 3 row(s).