Tair (Redis® OSS-Compatible)：exHash

類別

說明

文法

EXHSET key field value [EX time] [EXAT time] [PX time] [PXAT time] [NX | XX] [VER | ABS version] [KEEPTTL]

時間複雜度

O(1)

命令描述

向Key指定的TairHash中插入一個field。如果TairHash不存在則自動建立一個，如果field已經存在則覆蓋其值。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

• value：field對應的值，一個field只能有一個value。

• EX：指定field的相對到期時間，單位為秒，為0表示馬上到期，不傳此參數表示不到期。

• EXAT：指定field的絕對到期時間，單位為秒，為0表示馬上到期，不傳此參數表示不到期。

• PX：指定field的相對到期時間，單位為毫秒，為0表示馬上到期，不傳此參數表示不到期。

• PXAT：指定field的絕對到期時間，單位為毫秒 ，為0表示馬上到期，不傳此參數表示不到期。

• NX：只在field不存在時插入。

• XX：只在field存在時插入。

• VER：版本號碼。

  • 如果field存在，和目前的版本號做比較：

    • 如果相等，繼續操作，且版本號碼加1。

    • 如果不相等，返回異常。

  • 如果field不存在或者field目前的版本為0，忽略傳入的版本號碼並繼續操作，成功後版本號碼變為1。

• ABS：絕對版本號碼，不論field是否存在，可以在插入field時設定為本參數所指定的版本號碼。

• KEEPTTL：在不指定EX、EXAT、PX或PXAT選項時，使用KEEPTTL選項會保留field當前的到期設定。

  說明

  若不使用KEEPTTL選項，EXHSET命令會預設刪除field上原先設定的到期時間。

傳回值

• 建立field並成功為它設定值：1。

• field已經存在，成功覆蓋舊值：0。

• 指定了XX且field不存在：-1。

• 指定了NX且field已經存在：-1。

• 指定了VER且版本和目前的版本不匹配："ERR update version is stale"。

• 其它情況返回相應的異常資訊。

樣本

命令樣本：

EXHSET myhash field1 val EX 10

返回樣本：

(integer) 1

類別

說明

文法

EXHGET key field

時間複雜度

O(1)

命令描述

擷取key指定的TairHash中一個field的值，如果TairHash不存在或者field不存在，則返回nil。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

傳回值

• field存在且操作成功：field對應的值。

• key不存在或者field不存在：nil。

• 其它情況返回相應的異常資訊。

樣本

提前執行EXHSET myhash field1 val命令。

命令樣本：

EXHGET myhash field1

返回樣本：

"val"

類別

說明

文法

EXHMSET key field value [field value ...]

時間複雜度

O(N)

命令描述

同時向key指定的TairHash中插入多個field，如果TairHash不存在則自動建立一個，如果field已經存在則覆蓋其值。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

• value：field對應的值，一個field只能有一個value。

傳回值

• 成功：OK。

• 其它情況返回相應的異常資訊。

樣本

命令樣本：

EXHMSET myhash field1 val1 field2 val2

返回樣本：

OK

類別

說明

文法

EXHPEXPIREAT key field milliseconds-timestamp [VER | ABS version]

時間複雜度

O(1)

命令描述

在key指定的TairHash中為一個field設定絕對到期時間，精確到毫秒。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

• milliseconds-timestamp：精確到毫秒的UNIX 時間戳記 （Unix timestamp）。

• VER：版本號碼。

  • 如果field存在，和目前的版本號做比較：

    • 如果相等，繼續操作，且版本號碼加1。

    • 如果不相等，返回異常。

  • 如果field不存在或者field目前的版本為0，忽略傳入的版本號碼並繼續操作，成功後版本號碼變為1。

• ABS：絕對版本號碼，不論field是否存在，可以在插入field時設定為本參數所指定的版本號碼。

傳回值

• field存在且設定成功：1。

• field不存在：0。

• 其它情況返回相應的異常資訊。

樣本

命令樣本：

EXHPEXPIREAT myhash field1 1293840000

返回樣本：

(integer) 1

類別

說明

文法

EXHPEXPIRE key field milliseconds [VER | ABS version]

時間複雜度

O(1)

命令描述

在key指定的TairHash中為一個field設定相對到期時間，單位為毫秒。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

• milliseconds：相對到期時間，單位為毫秒。

• VER：版本號碼。

  • 如果field存在，和目前的版本號做比較：

    • 如果相等，繼續操作，且版本號碼加1。

    • 如果不相等，返回異常。

  • 如果field不存在或者field目前的版本為0，忽略傳入的版本號碼並繼續操作，成功後版本號碼變為1。

• ABS：絕對版本號碼，不論field是否存在，可以在插入field時設定為本參數所指定的版本號碼。

傳回值

• field存在且設定成功：1。

• field不存在：0。

• 其它情況返回相應的異常資訊。

樣本

命令樣本：

EXHPEXPIRE myhash field1 1000

返回樣本：

(integer) 1

類別

說明

文法

EXHEXPIREAT key field timestamp [VER | ABS version]

時間複雜度

O(1)

命令描述

在key指定的TairHash中為一個field設定絕對到期時間，精確到秒。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

• timestamp：精確到秒的UNIX 時間戳記 （Unix timestamp）。

• VER：版本號碼。

  • 如果field存在，和目前的版本號做比較：

    • 如果相等，繼續操作，且版本號碼加1。

    • 如果不相等，返回異常。

  • 如果field不存在或者field目前的版本為0，忽略傳入的版本號碼並繼續操作，成功後版本號碼變為1。

• ABS：絕對版本號碼，不論field是否存在，可以在插入field時設定為本參數所指定的版本號碼。

傳回值

• field存在且設定成功：1。

• field不存在：0。

• 其它情況返回相應的異常資訊。

樣本

命令樣本：

EXHEXPIREAT myhash field1 1293840000

返回樣本：

(integer) 1

類別

說明

文法

EXHEXPIRE key field seconds [VER | ABS version]

時間複雜度

O(1)

命令描述

在key指定的TairHash中為一個field設定相對到期時間，單位為秒。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

• seconds：相對到期時間，單位為秒。

• VER：版本號碼。

  • 如果field存在，和目前的版本號做比較：

    • 如果相等，繼續操作，且版本號碼加1。

    • 如果不相等，返回異常。

  • 如果field不存在或者field目前的版本為0，忽略傳入的版本號碼並繼續操作，成功後版本號碼變為1。

• ABS：絕對版本號碼，不論field是否存在，可以在插入field時設定為本參數所指定的版本號碼。

傳回值

• field存在且設定成功：1。

• field不存在：0。

• 其它情況返回相應的異常資訊。

樣本

命令樣本：

EXHEXPIRE myhash field1 100

返回樣本：

(integer) 1

類別

說明

文法

EXHPTTL key field

時間複雜度

O(1)

命令描述

查看key指定的TairHash中一個field的剩餘到期時間，結果精確到毫秒。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

傳回值

• field存在但是沒有設定到期時間：-1。

• key或者field不存在：-2。

• field不存在：-3。

• field存在且設定了到期時間：到期時間，單位為毫秒。

• 其它情況返回相應的異常資訊。

樣本

提前執行EXHSET myhash field1 val1 EX 100命令。

命令樣本：

EXHPTTL myhash field1

返回樣本：

(integer) 97213

類別

說明

文法

EXHTTL key field

時間複雜度

O(1)

命令描述

查看key指定的TairHash中一個field的到期時間，結果精確到秒。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

傳回值

• key或者field不存在：-2。

• field存在但是沒有設定到期時間：-1。

• field存在且設定了到期時間：到期時間，單位為秒。

• 其它情況返回相應的異常資訊。

樣本

提前執行EXHSET myhash field1 val1 EX 100命令。

命令樣本：

EXHTTL myhash field1

返回樣本：

(integer) 85

類別

說明

文法

EXHVER key field

時間複雜度

O(1)

命令描述

查看key指定的TairHash中一個field的目前的版本號。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

傳回值

• key不存在：-1。

• field不存在：-2。

• 查詢成功：field的版本號碼。

• 其它情況返回相應的異常資訊。

樣本

命令樣本：

EXHVER myhash field1

返回樣本：

(integer) 1

類別

說明

文法

EXHSETVER key field version

時間複雜度

O(1)

命令描述

設定key指定的TairHash中一個field的版本號碼。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

傳回值

• TairHash或者field不存在：0。

• 設定成功：1。

• 其它情況返回相應的異常資訊。

樣本

命令樣本：

EXHSETVER myhash field1 3

返回樣本：

(integer) 1

類別

說明

文法

EXHINCRBY key field num [EX time] [EXAT time] [PX time] [PXAT time] [VER | ABS version] [MIN minval] [MAX maxval] [KEEPTTL]

時間複雜度

O(1)

命令描述

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

• num：需要為field的value增加的整數值。

• EX：指定field的相對到期時間，單位為秒，為0表示馬上到期，不傳此參數表示不到期。

• EXAT：指定field的絕對到期時間，單位為秒，為0表示馬上到期，不傳此參數表示不到期。

• PX：指定field的相對到期時間，單位為毫秒，為0表示馬上到期，不傳此參數表示不到期。

• PXAT：指定field的絕對到期時間，單位為毫秒 ，為0表示馬上到期，不傳此參數表示不到期。

• VER：版本號碼。

  • 如果field存在，和目前的版本號做比較：

    • 如果相等，繼續操作，且版本號碼加1。

    • 如果不相等，返回異常。

  • 如果field不存在或者field目前的版本為0，忽略傳入的版本號碼並繼續操作，成功後版本號碼變為1。

• ABS：絕對版本號碼，不論field是否存在，可以在插入field時設定為本參數所指定的版本號碼。

• MIN：value的最小值，小於該值則提示異常。

• MAX：value的最大值，大於該值則提示異常。

• KEEPTTL：在不指定EX、EXAT、PX或PXAT選項時，使用KEEPTTL選項會保留field當前的到期設定。

傳回值

• 成功：與num相加後value的值。

• 其它情況返回異常。

樣本

提前執行EXHMSET myhash field1 10命令。

命令樣本：

EXHINCRBY myhash field1 100

返回樣本：

(integer) 110

類別

說明

文法

EXHINCRBYFLOAT key field num [EX time] [EXAT time] [PX time] [PXAT time] [VER | ABS version] [MIN minval] [MAX maxval] [KEEPTTL]

時間複雜度

O(1)

命令描述

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

• num：需要為field的value增加的值，類型為浮點。

• EX：指定field的相對到期時間，單位為秒，為0表示馬上到期，不傳此參數表示不到期。

• EXAT：指定field的絕對到期時間，單位為秒，為0表示馬上到期，不傳此參數表示不到期。

• PX：指定field的相對到期時間，單位為毫秒，為0表示馬上到期，不傳此參數表示不到期。

• PXAT：指定field的絕對到期時間，單位為毫秒 ，為0表示馬上到期，不傳此參數表示不到期。

• VER：版本號碼。

  • 如果field存在，和目前的版本號做比較：

    • 如果相等，繼續操作，且版本號碼加1。

    • 如果不相等，返回異常。

  • 如果field不存在或者field目前的版本為0，忽略傳入的版本號碼並繼續操作，成功後版本號碼變為1。

• ABS：絕對版本號碼，不論field是否存在，可以在插入field時設定為本參數所指定的版本號碼。

• MIN：value的最小值，小於該值則提示異常。

• MAX：value的最大值，大於該值則提示異常。

• KEEPTTL：在不指定EX、EXAT、PX或PXAT選項時，使用KEEPTTL選項會保留field當前的到期設定。

傳回值

• 成功：與num相加後value的值。

• 其它情況返回異常。

樣本

提前執行EXHMSET myhash field1 10命令。

命令樣本：

EXHINCRBYFLOAT myhash field1 9.235

返回樣本：

"19.235"

類別

說明

文法

EXHGETWITHVER key field

時間複雜度

O(1)

命令描述

同時擷取key指定的TairHash一個field的值和版本，如果TairHash不存在或者field不存在，則返回nil。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

傳回值

• field存在且操作成功：field對應的值和版本。

• key不存在或者field不存在：nil。

• 其它情況返回相應的異常資訊。

樣本

命令樣本：

EXHGETWITHVER myhash field1

返回樣本：

1) "19.235"
2) (integer) 5

類別

說明

文法

EXHMGET key field [field ...]

時間複雜度

O(1)

命令描述

同時擷取key指定的TairHash多個field的值，如果TairHash不存在或者field不存在，則返回nil。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

傳回值

• key不存在：nil。

• key存在且查詢的所有field都存在：返回一個數組，數組的每一個元素對應一個field的value。

• key存在且查詢的field中有不存在的：返回一個數組，數組的每一個元素對應一個field的value，不存在的field對應的元素顯示為nil。

• 其它情況返回相應的異常資訊。

樣本

提前執行EXHMSET myhash field1 10 field2 var1命令。

命令樣本：

EXHMGET myhash field1 field2

返回樣本：

1) "10"
2) "var1"

類別

說明

文法

EXHMGETWITHVER key field [field ...]

時間複雜度

O(1)

命令描述

同時擷取key指定的TairHash多個field的值和版本。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

傳回值

• key不存在：nil。

• key存在且查詢的所有field都存在：返回一個數組，數組的每一個元素對應一個field的value和version。

• key存在且查詢的field中有不存在的：返回一個數組，數組的每一個元素對應一個field的value和version，不存在的field對應的元素顯示為nil。

• 其它情況返回相應的異常資訊。

樣本

提前執行EXHMSET myhash field1 10 field2 var1命令。

命令樣本：

 EXHMGETWITHVER myhash field1 field2

返回樣本：

1) 1) "10"
   2) (integer) 1
2) 1) "var1"
   2) (integer) 1

類別

說明

文法

EXHLEN key [NOEXP]

時間複雜度

未設定NOEXP選項時是O(1)，設定NOEXP選項時是O(N)。

命令描述

擷取key指定的TairHash中field個數，該命令不會觸發對到期field的被動淘汰，也不會將其過濾掉，所以結果中可能包含已經到期但還未被刪除的field。如果只想返回當前沒有到期的field個數，可以在命令中設定NOEXP選項。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• NOEXP：該命令預設不會觸發對到期field的被動淘汰，也不會將其過濾掉，所以結果中可能包含已經到期但還未被刪除的field。如果只想返回當前沒有到期的field個數，可以在命令中設定NOEXP選項。在設定NOEXP時：

  • 因為要遍曆整條TairHash資料，EXHLEN命令的回應時間將受到Tairhash大小的影響。

  • EXHLEN命令的返回結果中會過濾掉到期的field，但到期field不會被淘汰。

傳回值

• key不存在或者field不存在：0。

• 成功：field個數。

• 其它情況返回相應的異常資訊。

樣本

命令樣本：

EXHLEN myhash

返回樣本：

(integer) 2

類別

說明

文法

EXHEXISTS key field

時間複雜度

O(1)

命令描述

查詢key指定的TairHash中是否存在對應的field。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

傳回值

• key不存在或者field不存在：0。

• field存在：1。

• 其它情況返回相應的異常資訊。

樣本

命令樣本：

EXHEXISTS myhash field1

返回樣本：

(integer) 1

類別

說明

文法

EXHSTRLEN key field

時間複雜度

O(1)

命令描述

擷取key指定的TairHash中一個field對應的value的長度。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

傳回值

• key不存在或者field不存在：0。

• 查詢成功：value的長度。

• 其它情況返回相應的異常資訊。

樣本

命令樣本：

EXHSTRLEN myhash field1

返回樣本：

(integer) 2

類別

說明

文法

EXHKEYS key

時間複雜度

O(N)

命令描述

擷取key指定的TairHash中所有的field。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

傳回值

• key不存在：返回一個空數組。

• key存在：返回一個數組，數組的每一位對應TairHash中的每一個field。

• 其它情況返回相應的異常資訊。

樣本

提前執行EXHMSET myhash field1 10 field2 var1命令。

命令樣本：

EXHKEYS myhash

返回樣本：

1) "field1"
2) "field2"

類別

說明

文法

EXHVALS key

時間複雜度

O(N)

命令描述

擷取key指定的TairHash中所有field的值。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

傳回值

• key不存在：返回一個空數組。

• key存在：返回一個數組，數組的每個元素對應TairHash中的一個field的value。

• 其它情況返回相應的異常資訊。

樣本

提前執行EXHMSET myhash field1 10 field2 var1命令。

命令樣本：

EXHVALS myhash

返回樣本：

1) "10"
2) "var1"

類別

說明

文法

EXHGETALL key

時間複雜度

O(N)

命令描述

擷取key指定的TairHash中所有field及其value。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

傳回值

• key不存在：返回一個空數組。

• key存在：返回一個數組，數組的每個元素對應TairHash中的一對field和value。

• 其它情況返回相應的異常資訊。

樣本

提前執行EXHMSET myhash field1 10 field2 var1命令。

命令樣本：

EXHGETALL myhash

返回樣本：

1) "field1"
2) "10"
3) "field2"
4) "var1"

類別

說明

文法

EXHSCAN key op subkey [MATCH pattern] [COUNT count]

時間複雜度

每次調用時是O(1)，遍曆整個TairHash時是O(N)。

命令描述

選項

• key：TairHash的Key，用於指定作為命令調用對象的TairHash。

• op：用於定位掃描的起點，可選值如下。

  • >：表示從第一個大於subkey的field開始。

  • >=：表示從第一個大於等於subkey的field開始。

  • <：表示從第一個小於subkey的field開始。

  • <=：表示從第一個小於等於subkey的field開始。

  • ==：表示從第一個等於subkey的field開始。

  • ^：表示從第一個field開始。

  • $：表示從最後一個field開始。

• subkey：用於與op選項搭配，設定掃描起始位置，當op為^或$時該值將被忽略。

• MATCH：用於過濾掃描結果，根據MATCH指定的pattern對subkey進行正則過濾。

• COUNT：用於規定單次掃描field的個數（預設為10）。

  說明

  COUNT僅表示每次掃描TairHash的field的個數，不代表最終一定會返回COUNT個field結果集，結果集的大小還要根據TairHash中當前field個數和是否指定MATCH進行過濾而定。

傳回值

• Key不存在：返回一個空數組。

• Key存在：返回一個具有兩個元素的數組：

  • 第一個元素：下一次掃描的起始field，如果該Key已掃描完成，則該元素為空白。

  • 第二個元素：本次掃描結果，包含field和value。

• 其它情況返回相應的異常資訊。

樣本

提前執行EXHMSET myhashkey field1 val1 field2 val2 field3 val3 field4 val4 field5 val5命令。

命令樣本：

EXHSCAN myhashkey ^ xx COUNT 3

返回樣本：

1) "field4"
2) 1) "field1"
   2) "val1"
   3) "field2"
   4) "val2"
   5) "field3"
   6) "val3"

類別

說明

文法

EXHSCANUNORDER key cursor [MATCH pattern] [COUNT count]

時間複雜度

每次調用時是O(1)，遍曆整個TairHash時是O(N)。

命令描述

選項

• key：TairHash的Key，用於指定作為命令調用對象的TairHash。

• cursor：指定本次掃描的遊標

• MATCH：用於過濾掃描結果，根據MATCH指定的pattern對待掃描的Key進行正則過濾。

• COUNT：用於規定單次掃描field的個數（預設為10）。

  說明

  COUNT僅表示每次掃描TairHash的field的個數，不代表最終一定會返回COUNT個field結果集，結果集的大小還要根據TairHash中當前field個數和是否指定MATCH進行過濾而定。

傳回值

• Key不存在：返回一個空數組。

• Key存在：返回一個具有兩個元素的數組：

  • 第一個元素：下次查詢的cursor，若該Key已掃描完成，則返回0。

  • 第二個元素：本次掃描結果，包含field和value。

• 其它情況返回相應的異常資訊。

樣本

提前執行EXHMSET myhashkey field1 val1 field2 val2 field3 val3 field4 val4 field5 val5命令。

命令樣本：

EXHSCANUNORDER myhashkey 0 COUNT 3

返回樣本：

1) "1"
2) 1) "field5"
   2) "val5"
   3) "field2"
   4) "val2"

類別

說明

文法

EXHDEL key field [field ...]

時間複雜度

O(1)

命令描述

刪除key指定的TairHash中的一個field，如果TairHash不存在或者field不存在則返回0 ，成功刪除返回1。

選項

• Key：TairHash的key，用於指定作為命令調用對象的TairHash。

• field：TairHash中的一個元素，一個TairHash key可以有多個field。

傳回值

• key不存在或者field不存在：0。

• 刪除成功：1。

• 其它情況返回相應的異常資訊。

樣本

命令樣本：

EXHDEL myhash field1

返回樣本：

(integer) 1