Queries and history

    accepts the following parameters:

    • Key: a key of an item
    • Offset: the starting index (excluded from the search). Optional
    • Limit: maximum returned items. Optional
    • Desc: items are returned in reverse order. Optional
    • SinceTx:
    1. try {
    2.     immuClient.set("hello", value1);
    3.     immuClient.set("hello", value2);
    4. } catch (CorruptedDataException e) {
    5.     // ...
    6. }
    8. List<KV> historyResponse1 = immuClient.history("hello", 10, 0, false, 1);

    Note that, similar with many other methods, history method is overloaded to allow different kinds/set of parameters.

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on Python sdk github project (opens new window)

    1. import ImmudbClient from 'immudb-node'
    2. import Parameters from 'immudb-node/types/parameters'
    4. const IMMUDB_HOST = '127.0.0.1'
    5. const IMMUDB_PORT = '3322'
    6. const IMMUDB_USER = 'immudb'
    7. const IMMUDB_PWD = 'immudb'
    9. const cl = new ImmudbClient({ host: IMMUDB_HOST, port: IMMUDB_PORT });
    11. (async () => {
    12.     await cl.login({ user: IMMUDB_USER, password: IMMUDB_PWD })
    14.     const key = 'hello'
    16.     await cl.set({ key, value: 'immutable world' })
    17.     await cl.set({ key, value: 'immudb' })
    19.     const historyReq: Parameters.History = {
    20.         key
    21.     }
    22.     const historyRes = cl.history(historyReq)
    23.     console.log('success: history', historyRes)
    24. })()

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on

    If you’re using another development language, please read up on our immugw (opens new window) option.

    Counting entries is not supported at the moment.

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on Java sdk github project (opens new window)

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on Node.js sdk github project (opens new window)

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on

    The scan command is used to iterate over the collection of elements present in the currently selected database. Scan accepts the following parameters:

    • Prefix: prefix. If not provided all keys will be involved. Optional
    • SeekKey: initial key for the first entry in the iteration. Optional
    • Desc: DESC or ASC sorting order. Optional
    • Limit: maximum returned items. Optional
    • SinceTx: immudb will wait that the transaction provided by SinceTx be processed. Optional
    • NoWait: Default false. When true scan doesn’t wait for the index to be fully generated and returns the last indexed value. Optional

    An ordinary scan command and a reversed one.

    1.     client.Set(ctx, []byte(`aaa`), []byte(`item1`))
    2.     client.Set(ctx, []byte(`bbb`), []byte(`item2`))
    3.     client.Set(ctx, []byte(`abc`),[]byte(`item3`))
    5.     scanReq := &schema.ScanRequest{
    6.         Prefix:  []byte(`a`),
    7.     }
    9.     list, err := client.Scan(ctx, scanReq)
    10.     if err != nil {
    11.         log.Fatal(err)
    12.     }
    13.     fmt.Printf("%v\n", list)
    14.     scanReq1 := &schema.ScanRequest{
    15.         SeekKey: []byte{0xFF},
    16.         Prefix:  []byte(`a`),
    17.         Desc:    true,
    18.     }
    20.     list, err = client.Scan(ctx, scanReq1)
    21.     if err != nil {
    22.         log.Fatal(err)
    23.     }
    24.     fmt.Printf("%v\n", list)
    26.     // scan on all key  values on the current database, with a fresh snapshot
    27.     scanReq2 := &schema.ScanRequest{
    28.         SeekKey: []byte{0xFF},
    29.         Desc:    true,
    30.         SinceTx: math.MaxUint64,
    31.     }
    33.     list, err = client.Scan(ctx, scanReq2)
    34.     if err != nil {
    35.         log.Fatal(err)
    36.     }
    37.     fmt.Printf("%v\n", list)
    1. byte[] value1 = {0, 1, 2, 3};
    2. byte[] value2 = {4, 5, 6, 7};
    4. try {
    5.     immuClient.set("scan1", value1);
    6.     immuClient.set("scan2", value2);
    7. } catch (CorruptedDataException e) {
    8.     // ...
    9. }
    11. // Example of using scan(prefix, sinceTxId, limit, desc).
    12. List<KV> scanResult = immuClient.scan("scan", 1, 5, false);
    13. // We expect two entries in the result.

    scan is an overloaded method, therefore multiple flavours of it with different parameter options exist.

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on Python sdk github project (opens new window)

    Example with an offset:

    1. import ImmudbClient from 'immudb-node'
    2. import Parameters from 'immudb-node/types/parameters'
    4. const IMMUDB_HOST = '127.0.0.1'
    5. const IMMUDB_PORT = '3322'
    6. const IMMUDB_USER = 'immudb'
    7. const IMMUDB_PWD = 'immudb'
    9. const cl = new ImmudbClient({ host: IMMUDB_HOST, port: IMMUDB_PORT });
    11. (async () => {
    12.     await cl.login({ user: IMMUDB_USER, password: IMMUDB_PWD })
    15.     await cl.set({ key: 'abc', value: 'item3' })
    17.     const scanReq: Parameters.Scan = {
    18.         seekkey: '',
    19.         prefix: '',
    20.         desc: true,
    21.         limit: 0,
    22.         sincetx: 0
    23.     }
    24.     const scanRes = await cl.scan(scanReq)
    25.     console.log('success: scan', scanRes)
    27.     const scanReq1: Parameters.Scan = {
    28.         seekkey: 'bbb',
    29.         prefix: '',
    30.         desc: true,
    31.         limit: 0,
    32.         sincetx: 0
    33.     }
    34.     const scanRes1 = await cl.scan(scanReq1)
    35.     console.log('success: scan', scanRes1)
    37.     const scanReq2: Parameters.Scan = {
    38.         seekkey: 'b',
    39.         prefix: 'b',
    40.         desc: true,
    41.         limit: 0,
    42.         sincetx: 0
    43.     }
    44.     const scanRes2 = await cl.scan(scanReq2)
    45.     console.log('success: scan', scanRes2)
    46. })()

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on

    If you’re using another development language, please read up on our immugw (opens new window) option.

    SetReference is like a “tag” operation. It appends a reference on a key/value element. As a consequence, when we retrieve that reference with a Get or VerifiedGet the value retrieved will be the original value associated with the original key. Its VerifiedReference counterpart is the same except that it also produces the inclusion and consistency proofs.

    1.     _, err = client.Set(ctx, []byte(`firstKey`),[]byte(`firstValue`))
    2.     if err != nil {
    3.         log.Fatal(err)
    4.     }
    5.     reference, err := client.SetReference(ctx, []byte(`myTag`), []byte(`firstKey`))
    6.     if err != nil {
    7.         log.Fatal(err)
    8.     }
    10.     fmt.Printf("%v\n", reference)
    11.     firstItem, err := client.Get(ctx, []byte(`myTag`))
    12.     if err != nil {
    13.         log.Fatal(err)
    14.     }
    15.     fmt.Printf("%v\n", firstItem)

    Example with verifications

    1.     _, err = client.Set(ctx, []byte(`secondKey`),[]byte(`secondValue`))
    2.     if err != nil {
    3.         log.Fatal(err)
    4.     }
    5.     reference, err = client.VerifiedSetReference(ctx, []byte(`mySecondTag`), []byte(`secondKey`))
    6.     if err != nil {
    7.         log.Fatal(err)
    8.     }
    9.     fmt.Printf("%v\n", reference)
    11.     secondItem, err := client.Get(ctx, []byte(`mySecondTag`))
    12.     if err != nil {
    13.         log.Fatal(err)
    14.     }
    15.     fmt.Printf("%v\n", secondItem)
    1. byte[] key = "testRef".getBytes(StandardCharsets.UTF_8);
    2. byte[] val = "abc".getBytes(StandardCharsets.UTF_8);
    4. TxMetadata txMd = null;
    5. try {
    6.     txMd = immuClient.set(key, val);
    7. } catch (CorruptedDataException e) {
    8.     // ...
    9. }
    11. byte[] ref1Key = "ref1_to_testRef".getBytes(StandardCharsets.UTF_8);
    12. byte[] ref2Key = "ref2_to_testRef".getBytes(StandardCharsets.UTF_8);
    14. try {
    15.     txMd = immuClient.setReference(ref1Key, key);
    16. } catch (CorruptedDataException e) {
    17.     // ...
    18. }
    20. try {
    21.     txMd = immuClient.verifiedSetReference(ref2Key, key);
    22. } catch (VerificationException e) {
    23.     // ...
    24. }

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on 

    1. import ImmudbClient from 'immudb-node'
    2. import Parameters from 'immudb-node/types/parameters'
    4. const IMMUDB_HOST = '127.0.0.1'
    5. const IMMUDB_PORT = '3322'
    6. const IMMUDB_USER = 'immudb'
    7. const IMMUDB_PWD = 'immudb'
    9. const cl = new ImmudbClient({ host: IMMUDB_HOST, port: IMMUDB_PORT });
    11. (async () => {
    12.     await cl.login({ user: IMMUDB_USER, password: IMMUDB_PWD })
    14.     const setReq: Parameters.Set = {
    15.         key: 'firstKey',
    16.         value: 'firstValue'
    17.     }
    18.     await cl.set(setReq)
    20.     const verifiedReferenceReq: Parameters.SetReference = {
    21.         key: 'myTag',
    22.         referencedKey: 'firstKey'
    23.     }
    24.     const verifiedReferenceRes = await cl.verifiedSetReference(verifiedReferenceReq)
    26.     const getReq: Parameters.Get = {
    27.         key: 'myTag'
    28.     }
    29.     const getRes = await cl.get(getReq)
    30.     console.log('success: get by reference', getRes)
    31. })()

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on .Net sdk github project (opens new window)

    If you’re using another development language, please read up on our option.

    When reference is resolved with get or verifiedGet in case of multiples equals references the last reference is returned.

    1.     _, err = client.Set(ctx, []byte(`secondKey`),[]byte(`secondValue`))
    2.     if err != nil {
    3.         log.Fatal(err)
    4.     }
    5.     _, err = client.Set(ctx, []byte(`secondKey`),[]byte(`thirdValue`))
    6.     if err != nil {
    7.         log.Fatal(err)
    8.     }
    9.     reference, err = client.VerifiedSetReference(ctx, []byte(`myThirdTag`), []byte(`secondKey`))
    10.     if err != nil {
    11.         log.Fatal(err)
    12.     }
    13.     fmt.Printf("%v\n", reference)
    15.     thirdItem, err := client.Get(ctx, []byte(`myThirdTag`))
    16.     if err != nil {
    17.         log.Fatal(err)
    18.     }
    19.     fmt.Printf("%v\n", thirdItem)

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on Java sdk github project (opens new window)

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on 

    1. import ImmudbClient from 'immudb-node'
    2. import Parameters from 'immudb-node/types/parameters'
    4. const IMMUDB_HOST = '127.0.0.1'
    5. const IMMUDB_PORT = '3322'
    6. const IMMUDB_USER = 'immudb'
    7. const IMMUDB_PWD = 'immudb'
    9. const cl = new ImmudbClient({ host: IMMUDB_HOST, port: IMMUDB_PORT });
    11. (async () => {
    12.     await cl.login({ user: IMMUDB_USER, password: IMMUDB_PWD })
    14.     const setReq: Parameters.Set = {
    15.         key: 'firstKey',
    16.         value: 'firstValue'
    17.     }
    18.     await cl.set(setReq)
    19.     const setReq1: Parameters.Set = {
    20.         key: 'secondKey',
    21.         value: 'secondValue'
    22.     }
    23.     await cl.set(setReq1)
    25.     const verifiedReferenceReq: Parameters.SetReference = {
    26.         key: 'myTag',
    27.         referencedKey: 'firstKey'
    28.     }
    29.     await cl.verifiedSetReference(verifiedReferenceReq)
    30.     const verifiedReferenceReq1: Parameters.SetReference = {
    31.         key: 'myTag',
    32.         referencedKey: 'secondKey'
    33.     }
    34.     await cl.verifiedSetReference(verifiedReferenceReq1)
    36.     const getReq: Parameters.Get = {
    37.         key: 'myTag'
    38.     }
    39.     const getSecondItemRes = await cl.get(getReq)
    40.     console.log('success: get by second reference', getSecondItemRes)
    41. })()

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on .Net sdk github project (opens new window)

    If you’re using another development language, please read up on our option.

    It’s possible to bind a reference to a key on a specific transaction using SetReferenceAt and VerifiedSetReferenceAt

    1.     meta, err := client.Set(ctx, []byte(`secondKey`),[]byte(`secondValue`))
    2.     if err != nil {
    3.         log.Fatal(err)
    4.     }
    5.     _ , err = client.Set(ctx, []byte(`secondKey`),[]byte(`thirdValue`))
    6.     if err != nil {
    7.         log.Fatal(err)
    8.     }
    9.     reference, err = client.VerifiedSetReferenceAt(ctx, []byte(`myThirdTag`), []byte(`secondKey`), meta.Id )
    10.     if err != nil {
    11.         log.Fatal(err)
    12.     }
    13.     fmt.Printf("%v\n", reference)
    15.     thirdItem, err := client.Get(ctx, []byte(`myThirdTag`))
    16.     if err != nil {
    17.         log.Fatal(err)
    18.     }
    19.     fmt.Printf("%v\n", thirdItem)

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on Python sdk github project (opens new window)

    1. import ImmudbClient from 'immudb-node'
    2. import Parameters from 'immudb-node/types/parameters'
    4. const IMMUDB_HOST = '127.0.0.1'
    5. const IMMUDB_PORT = '3322'
    6. const IMMUDB_USER = 'immudb'
    7. const IMMUDB_PWD = 'immudb'
    9. const cl = new ImmudbClient({ host: IMMUDB_HOST, port: IMMUDB_PORT });
    11. (async () => {
    12.     await cl.login({ user: IMMUDB_USER, password: IMMUDB_PWD })
    14.     const { id } = await cl.set({ key: 'firstKey', value: 'firstValue' })
    15.     await cl.set({ key: 'firstKey', value: 'secondValue' })
    17.     const verifiedSetReferenceAtReq: Parameters.VerifiedSetReferenceAt = {
    18.         key: 'myFirstTag',
    19.         referencedKey: 'firstKey',
    20.         attx: id
    21.     }
    22.     const verifiedSetReferenceAtRes = await cl.verifiedSetReferenceAt(verifiedSetReferenceAtReq)
    23.     console.log('success: verifiedSetReferenceAt', verifiedSetReferenceAtRes)
    25.     const getSecondItemRes = await cl.get({ key: 'myFirstTag' })
    26.     console.log('success: get second item by reference', getSecondItemRes)

    This feature is not yet supported or not documented. Do you want to make a feature request or help out? Open an issue on

    If you’re using another development language, please read up on our immugw (opens new window) option.