Chapter 8. Using Data Types

Table of Contents

Using Arrays
Using Binary
Using Enums
Using Fixed Binary
Using Maps
Using Embedded Records

Many of the types that Oracle NoSQL Database offers are easy to use. Examples of their usage has been scattered throughout this manual. However, some types are a little more complicated to use because they use container methods. They are also declared a little bit differently when defining tables using the CLI. This chapter describes their usage.

The types described in this chapter are: Arrays, Maps, Records, Enums, and Byte Arrays.

This chapter shows how to read and write values of each of these types.

Using Arrays

Arrays are a sequence of values all of the same type.

When you declare a table field as an array, you use add-array-field. This puts you into a special submode where you add one and only one field. The name you give the field is optional, unimportant and will be ignored. What you are really doing when you add this sub-field is declaring the type of the elements in the array.

To define a simple two-column table where the primary key is a UID and the second column contains array of strings, you use the following script:

## Enter into table creation mode
table create -name myTable
## Now add the fields
add-field -type INTEGER -name uid

## Create an array field. This puts us into a new submode.
add-array-field -name myArray
## Sets the type for the array. The name is required but ignored
add-field -type STRING -name arrayField

### Exit array field creation mode
exit

## A primary key must be defined for every table
primary-key -field uid

## Exit table creation mode
exit

## Add the table to the store.
plan add-table -name myTable -wait 

To write the array, use Row.putArray(), which returns an ArrayValue class instance. You then use ArrayValue.put() to write elements to the array:

TableAPI tableH = kvstore.getTableAPI();

Table myTable = tableH.getTable("myTable");

Row row = myTable.createRow();
row.put("uid", 12345);

ArrayValue av = row.putArray("myArray");
av.add("One");
av.add("Two");
av.add("Three"); 

tableH.put(row, null, null);

Note that ArrayValue has methods that allow you to add multiple values to the array by appending an array of values to the array. This assumes the array of values matches the array's schema. For example, the previous example could be done in the following way:

TableAPI tableH = kvstore.getTableAPI();

Table myTable = tableH.getTable("myTable");

Row row = myTable.createRow();
row.put("uid", 12345);

ArrayValue av = row.putArray("myArray");
String myStrings[] = {"One", "Two", "Three"};
av.add(myStrings);

tableH.put(row, null, null);

To read the array, use Row.get().asArray(). This returns an ArrayValue class instance. You can then use ArrayValue.get() to retrieve an element of the array from a specified index, or you can use ArrayValue.toList() to return the array as a Java List. In either case, the retrieved values are returned as a FieldValue, which allows you to retrieve the encapsulated value using a cast method such as FieldValue.asString().

For example, to iterate over the array created in the previous example:

TableAPI tableH = kvstore.getTableAPI();

Table myTable = tableH.getTable("myTable");

/* Create a primary key for user id 12345 and get a row */
PrimaryKey key = myTable.createPrimaryKey();
key.put("uid", 12345);
Row row = tableH.get(key, null);

/* Iterate over the array, displaying each element as a string */
ArrayValue av = row.get("myArray").asArray();
for (FieldValue fv: av.toList()) {
    System.out.println(fv.asString().get()); }