getBigDecimalListInternal(int columnIndex) {
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Mutation.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Mutation.java
index 73995a20df..6c869c549f 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Mutation.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Mutation.java
@@ -364,6 +364,8 @@ public int hashCode() {
* mutation equality to check for modifications before committing. We noticed that when NaNs where
* used the template would always indicate a modification was present, when it turned out not to
* be the case. For more information see b/206339664.
+ *
+ * Similar change is being done while calculating `Value.hashCode()`.
*/
private boolean areValuesEqual(List values, List otherValues) {
if (values == null && otherValues == null) {
@@ -385,9 +387,19 @@ private boolean areValuesEqual(List values, List otherValues) {
}
private boolean isNaN(Value value) {
- return !value.isNull()
- && value.getType().equals(Type.float64())
- && Double.isNaN(value.getFloat64());
+ return !value.isNull() && (isFloat64NaN(value) || isFloat32NaN(value));
+ }
+
+ // Checks if the Float64 value is either a "Double" or a "Float" NaN.
+ // Refer the comment above `areValuesEqual` for more details.
+ private boolean isFloat64NaN(Value value) {
+ return value.getType().equals(Type.float64()) && Double.isNaN(value.getFloat64());
+ }
+
+ // Checks if the Float32 value is either a "Double" or a "Float" NaN.
+ // Refer the comment above `areValuesEqual` for more details.
+ private boolean isFloat32NaN(Value value) {
+ return value.getType().equals(Type.float32()) && Float.isNaN(value.getFloat32());
}
static void toProto(Iterable mutations, List out) {
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/ResultSets.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/ResultSets.java
index a6cc7c729e..3d12cf5ad2 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/ResultSets.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/ResultSets.java
@@ -236,6 +236,16 @@ public long getLong(String columnName) {
return getCurrentRowAsStruct().getLong(columnName);
}
+ @Override
+ public float getFloat(int columnIndex) {
+ return getCurrentRowAsStruct().getFloat(columnIndex);
+ }
+
+ @Override
+ public float getFloat(String columnName) {
+ return getCurrentRowAsStruct().getFloat(columnName);
+ }
+
@Override
public double getDouble(int columnIndex) {
return getCurrentRowAsStruct().getDouble(columnIndex);
@@ -388,6 +398,26 @@ public List getLongList(String columnName) {
return getCurrentRowAsStruct().getLongList(columnName);
}
+ @Override
+ public float[] getFloatArray(int columnIndex) {
+ return getCurrentRowAsStruct().getFloatArray(columnIndex);
+ }
+
+ @Override
+ public float[] getFloatArray(String columnName) {
+ return getCurrentRowAsStruct().getFloatArray(columnName);
+ }
+
+ @Override
+ public List getFloatList(int columnIndex) {
+ return getCurrentRowAsStruct().getFloatList(columnIndex);
+ }
+
+ @Override
+ public List getFloatList(String columnName) {
+ return getCurrentRowAsStruct().getFloatList(columnName);
+ }
+
@Override
public double[] getDoubleArray(int columnIndex) {
return getCurrentRowAsStruct().getDoubleArray(columnIndex);
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Struct.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Struct.java
index 40c30148d0..0e65fa7f1b 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Struct.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Struct.java
@@ -27,6 +27,7 @@
import com.google.common.collect.ImmutableList;
import com.google.common.primitives.Booleans;
import com.google.common.primitives.Doubles;
+import com.google.common.primitives.Floats;
import com.google.common.primitives.Longs;
import com.google.protobuf.AbstractMessage;
import com.google.protobuf.ProtocolMessageEnum;
@@ -180,6 +181,11 @@ protected long getLongInternal(int columnIndex) {
return values.get(columnIndex).getInt64();
}
+ @Override
+ protected float getFloatInternal(int columnIndex) {
+ return values.get(columnIndex).getFloat32();
+ }
+
@Override
protected double getDoubleInternal(int columnIndex) {
return values.get(columnIndex).getFloat64();
@@ -261,6 +267,16 @@ protected List getLongListInternal(int columnIndex) {
return values.get(columnIndex).getInt64Array();
}
+ @Override
+ protected float[] getFloatArrayInternal(int columnIndex) {
+ return Floats.toArray(getFloatListInternal(columnIndex));
+ }
+
+ @Override
+ protected List getFloatListInternal(int columnIndex) {
+ return values.get(columnIndex).getFloat32Array();
+ }
+
@Override
protected double[] getDoubleArrayInternal(int columnIndex) {
return Doubles.toArray(getDoubleListInternal(columnIndex));
@@ -382,6 +398,8 @@ private Object getAsObject(int columnIndex) {
case INT64:
case ENUM:
return getLongInternal(columnIndex);
+ case FLOAT32:
+ return getFloatInternal(columnIndex);
case FLOAT64:
return getDoubleInternal(columnIndex);
case NUMERIC:
@@ -410,6 +428,8 @@ private Object getAsObject(int columnIndex) {
case INT64:
case ENUM:
return getLongListInternal(columnIndex);
+ case FLOAT32:
+ return getFloatListInternal(columnIndex);
case FLOAT64:
return getDoubleListInternal(columnIndex);
case NUMERIC:
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/StructReader.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/StructReader.java
index fd8cb77f39..f9967db045 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/StructReader.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/StructReader.java
@@ -123,6 +123,22 @@ public interface StructReader {
*/
long getLong(String columnName);
+ /**
+ * @param columnIndex index of the column
+ * @return the value of a non-{@code NULL} column with type {@link Type#float32()}.
+ */
+ default float getFloat(int columnIndex) {
+ throw new UnsupportedOperationException("method should be overwritten");
+ }
+
+ /**
+ * @param columnName name of the column
+ * @return the value of a non-{@code NULL} column with type {@link Type#float32()}.
+ */
+ default float getFloat(String columnName) {
+ throw new UnsupportedOperationException("method should be overwritten");
+ }
+
/**
* @param columnIndex index of the column
* @return the value of a non-{@code NULL} column with type {@link Type#float64()}.
@@ -361,6 +377,44 @@ default Value getValue(String columnName) {
*/
List getLongList(String columnName);
+ /**
+ * @param columnIndex index of the column
+ * @return the value of a non-{@code NULL} column with type {@code Type.array(Type.float32())}.
+ * @throws NullPointerException if any element of the array value is {@code NULL}. If the array
+ * may contain {@code NULL} values, use {@link #getFloatList(int)} instead.
+ */
+ default float[] getFloatArray(int columnIndex) {
+ throw new UnsupportedOperationException("method should be overwritten");
+ }
+
+ /**
+ * @param columnName name of the column
+ * @return the value of a non-{@code NULL} column with type {@code Type.array(Type.float32())}.
+ * @throws NullPointerException if any element of the array value is {@code NULL}. If the array
+ * may contain {@code NULL} values, use {@link #getFloatList(String)} instead.
+ */
+ default float[] getFloatArray(String columnName) {
+ throw new UnsupportedOperationException("method should be overwritten");
+ }
+
+ /**
+ * @param columnIndex index of the column
+ * @return the value of a non-{@code NULL} column with type {@code Type.array(Type.float32())} The
+ * list returned by this method is lazily constructed. Create a copy of it if you intend to
+ * access each element in the list multiple times.
+ */
+ default List getFloatList(int columnIndex) {
+ throw new UnsupportedOperationException("method should be overwritten");
+ }
+
+ /**
+ * @param columnName name of the column
+ * @return the value of a non-{@code NULL} column with type {@code Type.array(Type.float32())} The
+ * list returned by this method is lazily constructed. Create a copy of it if you intend to
+ * access each element in the list multiple times.
+ */
+ List getFloatList(String columnName);
+
/**
* @param columnIndex index of the column
* @return the value of a non-{@code NULL} column with type {@code Type.array(Type.float64())}.
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Type.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Type.java
index 348db5d04a..5d871227f5 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Type.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Type.java
@@ -48,6 +48,7 @@
public final class Type implements Serializable {
private static final Type TYPE_BOOL = new Type(Code.BOOL, null, null);
private static final Type TYPE_INT64 = new Type(Code.INT64, null, null);
+ private static final Type TYPE_FLOAT32 = new Type(Code.FLOAT32, null, null);
private static final Type TYPE_FLOAT64 = new Type(Code.FLOAT64, null, null);
private static final Type TYPE_NUMERIC = new Type(Code.NUMERIC, null, null);
private static final Type TYPE_PG_NUMERIC = new Type(Code.PG_NUMERIC, null, null);
@@ -59,6 +60,7 @@ public final class Type implements Serializable {
private static final Type TYPE_DATE = new Type(Code.DATE, null, null);
private static final Type TYPE_ARRAY_BOOL = new Type(Code.ARRAY, TYPE_BOOL, null);
private static final Type TYPE_ARRAY_INT64 = new Type(Code.ARRAY, TYPE_INT64, null);
+ private static final Type TYPE_ARRAY_FLOAT32 = new Type(Code.ARRAY, TYPE_FLOAT32, null);
private static final Type TYPE_ARRAY_FLOAT64 = new Type(Code.ARRAY, TYPE_FLOAT64, null);
private static final Type TYPE_ARRAY_NUMERIC = new Type(Code.ARRAY, TYPE_NUMERIC, null);
private static final Type TYPE_ARRAY_PG_NUMERIC = new Type(Code.ARRAY, TYPE_PG_NUMERIC, null);
@@ -89,9 +91,17 @@ public static Type int64() {
return TYPE_INT64;
}
+ /**
+ * Returns the descriptor for the {@code FLOAT32} type: a floating point type with the same value
+ * domain as a Java {@code float}.
+ */
+ public static Type float32() {
+ return TYPE_FLOAT32;
+ }
+
/**
* Returns the descriptor for the {@code FLOAT64} type: a floating point type with the same value
- * domain as a Java {code double}.
+ * domain as a Java {@code double}.
*/
public static Type float64() {
return TYPE_FLOAT64;
@@ -174,6 +184,8 @@ public static Type array(Type elementType) {
return TYPE_ARRAY_BOOL;
case INT64:
return TYPE_ARRAY_INT64;
+ case FLOAT32:
+ return TYPE_ARRAY_FLOAT32;
case FLOAT64:
return TYPE_ARRAY_FLOAT64;
case NUMERIC:
@@ -264,6 +276,7 @@ public enum Code {
NUMERIC(TypeCode.NUMERIC, "unknown"),
PG_NUMERIC(TypeCode.NUMERIC, "numeric", TypeAnnotationCode.PG_NUMERIC),
FLOAT64(TypeCode.FLOAT64, "double precision"),
+ FLOAT32(TypeCode.FLOAT32, "real"),
STRING(TypeCode.STRING, "character varying"),
JSON(TypeCode.JSON, "unknown"),
PG_JSONB(TypeCode.JSON, "jsonb", TypeAnnotationCode.PG_JSONB),
@@ -565,6 +578,8 @@ static Type fromProto(com.google.spanner.v1.Type proto) {
return bool();
case INT64:
return int64();
+ case FLOAT32:
+ return float32();
case FLOAT64:
return float64();
case NUMERIC:
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Value.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Value.java
index 3f0155e4a5..e4db5ff146 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Value.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Value.java
@@ -149,6 +149,20 @@ public static Value int64(long v) {
return new Int64Impl(false, v);
}
+ /**
+ * Returns a {@code FLOAT32} value.
+ *
+ * @param v the value, which may be null
+ */
+ public static Value float32(@Nullable Float v) {
+ return new Float32Impl(v == null, v == null ? 0 : v);
+ }
+
+ /** Returns a {@code FLOAT32} value. */
+ public static Value float32(float v) {
+ return new Float32Impl(false, v);
+ }
+
/**
* Returns a {@code FLOAT64} value.
*
@@ -454,6 +468,40 @@ public static Value int64Array(@Nullable Iterable v) {
return int64ArrayFactory.create(v);
}
+ /**
+ * Returns an {@code ARRAY} value.
+ *
+ * @param v the source of element values, which may be null to produce a value for which {@code
+ * isNull()} is {@code true}
+ */
+ public static Value float32Array(@Nullable float[] v) {
+ return float32Array(v, 0, v == null ? 0 : v.length);
+ }
+
+ /**
+ * Returns an {@code ARRAY} value that takes its elements from a region of an array.
+ *
+ * @param v the source of element values, which may be null to produce a value for which {@code
+ * isNull()} is {@code true}
+ * @param pos the start position of {@code v} to copy values from. Ignored if {@code v} is {@code
+ * null}.
+ * @param length the number of values to copy from {@code v}. Ignored if {@code v} is {@code
+ * null}.
+ */
+ public static Value float32Array(@Nullable float[] v, int pos, int length) {
+ return float32ArrayFactory.create(v, pos, length);
+ }
+
+ /**
+ * Returns an {@code ARRAY} value.
+ *
+ * @param v the source of element values. This may be {@code null} to produce a value for which
+ * {@code isNull()} is {@code true}. Individual elements may also be {@code null}.
+ */
+ public static Value float32Array(@Nullable Iterable v) {
+ return float32ArrayFactory.create(v);
+ }
+
/**
* Returns an {@code ARRAY} value.
*
@@ -729,6 +777,13 @@ private Value() {}
*/
public abstract long getInt64();
+ /**
+ * Returns the value of a {@code FLOAT32}-typed instance.
+ *
+ * @throws IllegalStateException if {@code isNull()} or the value is not of the expected type
+ */
+ public abstract float getFloat32();
+
/**
* Returns the value of a {@code FLOAT64}-typed instance.
*
@@ -835,6 +890,14 @@ public T getProtoEnum(
*/
public abstract List getInt64Array();
+ /**
+ * Returns the value of an {@code ARRAY}-typed instance. While the returned list itself
+ * will never be {@code null}, elements of that list may be null.
+ *
+ * @throws IllegalStateException if {@code isNull()} or the value is not of the expected type
+ */
+ public abstract List getFloat32Array();
+
/**
* Returns the value of an {@code ARRAY}-typed instance. While the returned list itself
* will never be {@code null}, elements of that list may be null.
@@ -1052,6 +1115,23 @@ Value newValue(boolean isNull, BitSet nulls, long[] values) {
return new Int64ArrayImpl(isNull, nulls, values);
}
};
+ private static final PrimitiveArrayValueFactory float32ArrayFactory =
+ new PrimitiveArrayValueFactory() {
+ @Override
+ float[] newArray(int size) {
+ return new float[size];
+ }
+
+ @Override
+ void set(float[] arr, int i, Float value) {
+ arr[i] = value;
+ }
+
+ @Override
+ Value newValue(boolean isNull, BitSet nulls, float[] values) {
+ return new Float32ArrayImpl(isNull, nulls, values);
+ }
+ };
private static final PrimitiveArrayValueFactory float64ArrayFactory =
new PrimitiveArrayValueFactory() {
@Override
@@ -1122,6 +1202,11 @@ public long getInt64() {
throw defaultGetter(Type.int64());
}
+ @Override
+ public float getFloat32() {
+ throw defaultGetter(Type.float32());
+ }
+
@Override
public double getFloat64() {
throw defaultGetter(Type.float64());
@@ -1181,6 +1266,11 @@ public List getInt64Array() {
throw defaultGetter(Type.array(Type.int64()));
}
+ @Override
+ public List getFloat32Array() {
+ throw defaultGetter(Type.array(Type.float32()));
+ }
+
@Override
public List getFloat64Array() {
throw defaultGetter(Type.array(Type.float64()));
@@ -1285,9 +1375,29 @@ public final boolean equals(Object o) {
@Override
public final int hashCode() {
- int result = Objects.hash(getType(), isNull);
+ Type typeToHash = getType();
+ int valueHash = isNull ? 0 : valueHash();
+
+ /**
+ * We are relaxing equality values here, making sure that Double.NaNs and Float.NaNs are equal
+ * to each other. This is because our Cloud Spanner Import / Export template in Apache Beam
+ * uses the mutation equality to check for modifications before committing. We noticed that
+ * when NaNs where used the template would always indicate a modification was present, when it
+ * turned out not to be the case.
+ *
+ * With FLOAT32 being introduced, we want to ensure the backward compatibility of the NaN
+ * equality checks that existed for FLOAT64. We're promoting the type to FLOAT64 while
+ * calculating the type hash when the value is a NaN. We're doing a similar type promotion
+ * while calculating valueHash of Float32 type. Note that this is not applicable for composite
+ * types containing FLOAT32.
+ */
+ if (type.getCode() == Type.Code.FLOAT32 && !isNull && Float.isNaN(getFloat32())) {
+ typeToHash = Type.float64();
+ }
+
+ int result = Objects.hash(typeToHash, isNull);
if (!isNull) {
- result = 31 * result + valueHash();
+ result = 31 * result + valueHash;
}
return result;
}
@@ -1492,6 +1602,46 @@ int valueHash() {
}
}
+ private static class Float32Impl extends AbstractValue {
+ private final float value;
+
+ private Float32Impl(boolean isNull, float value) {
+ super(isNull, Type.float32());
+ this.value = value;
+ }
+
+ @Override
+ public float getFloat32() {
+ checkNotNull();
+ return value;
+ }
+
+ @Override
+ com.google.protobuf.Value valueToProto() {
+ return com.google.protobuf.Value.newBuilder().setNumberValue(value).build();
+ }
+
+ @Override
+ void valueToString(StringBuilder b) {
+ b.append(value);
+ }
+
+ @Override
+ boolean valueEquals(Value v) {
+ return ((Float32Impl) v).value == value;
+ }
+
+ @Override
+ int valueHash() {
+ // For backward compatibility of NaN equality checks with Float64 NaNs.
+ // Refer the comment in `Value.hashCode()` for more details.
+ if (!isNull() && Float.isNaN(value)) {
+ return Double.valueOf(Double.NaN).hashCode();
+ }
+ return Float.valueOf(value).hashCode();
+ }
+ }
+
private static class Float64Impl extends AbstractValue {
private final double value;
@@ -2106,6 +2256,46 @@ int arrayHash() {
}
}
+ private static class Float32ArrayImpl extends PrimitiveArrayImpl {
+ private final float[] values;
+
+ private Float32ArrayImpl(boolean isNull, BitSet nulls, float[] values) {
+ super(isNull, Type.float32(), nulls);
+ this.values = values;
+ }
+
+ @Override
+ public List getFloat32Array() {
+ return getArray();
+ }
+
+ @Override
+ boolean valueEquals(Value v) {
+ Float32ArrayImpl that = (Float32ArrayImpl) v;
+ return Arrays.equals(values, that.values);
+ }
+
+ @Override
+ int size() {
+ return values.length;
+ }
+
+ @Override
+ Float getValue(int i) {
+ return values[i];
+ }
+
+ @Override
+ com.google.protobuf.Value getValueAsProto(int i) {
+ return com.google.protobuf.Value.newBuilder().setNumberValue(values[i]).build();
+ }
+
+ @Override
+ int arrayHash() {
+ return Arrays.hashCode(values);
+ }
+ }
+
private static class Float64ArrayImpl extends PrimitiveArrayImpl {
private final double[] values;
@@ -2588,6 +2778,8 @@ private Value getValue(int fieldIndex) {
return Value.pgJsonb(value.getPgJsonb(fieldIndex));
case BYTES:
return Value.bytes(value.getBytes(fieldIndex));
+ case FLOAT32:
+ return Value.float32(value.getFloat(fieldIndex));
case FLOAT64:
return Value.float64(value.getDouble(fieldIndex));
case NUMERIC:
@@ -2622,6 +2814,8 @@ private Value getValue(int fieldIndex) {
case BYTES:
case PROTO:
return Value.bytesArray(value.getBytesList(fieldIndex));
+ case FLOAT32:
+ return Value.float32Array(value.getFloatList(fieldIndex));
case FLOAT64:
return Value.float64Array(value.getDoubleList(fieldIndex));
case NUMERIC:
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/ValueBinder.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/ValueBinder.java
index 9915e12175..d675686ffe 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/ValueBinder.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/ValueBinder.java
@@ -81,6 +81,16 @@ public R to(@Nullable Long value) {
return handle(Value.int64(value));
}
+ /** Binds to {@code Value.float32(value)} */
+ public R to(float value) {
+ return handle(Value.float32(value));
+ }
+
+ /** Binds to {@code Value.float32(value)} */
+ public R to(@Nullable Float value) {
+ return handle(Value.float32(value));
+ }
+
/** Binds to {@code Value.float64(value)} */
public R to(double value) {
return handle(Value.float64(value));
@@ -198,6 +208,21 @@ public R toInt64Array(@Nullable Iterable values) {
return handle(Value.int64Array(values));
}
+ /** Binds to {@code Value.float32Array(values)} */
+ public R toFloat32Array(@Nullable float[] values) {
+ return handle(Value.float32Array(values));
+ }
+
+ /** Binds to {@code Value.float32Array(values, pos, length)} */
+ public R toFloat32Array(@Nullable float[] values, int pos, int length) {
+ return handle(Value.float32Array(values, pos, length));
+ }
+
+ /** Binds to {@code Value.float32Array(values)} */
+ public R toFloat32Array(@Nullable Iterable values) {
+ return handle(Value.float32Array(values));
+ }
+
/** Binds to {@code Value.float64Array(values)} */
public R toFloat64Array(@Nullable double[] values) {
return handle(Value.float64Array(values));
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/DirectExecuteResultSet.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/DirectExecuteResultSet.java
index 1b15ec5082..b5e4060ddd 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/DirectExecuteResultSet.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/DirectExecuteResultSet.java
@@ -180,6 +180,12 @@ public long getLong(String columnName) {
return delegate.getLong(columnName);
}
+ @Override
+ public float getFloat(int columnIndex) {
+ Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
+ return delegate.getFloat(columnIndex);
+ }
+
@Override
public double getDouble(int columnIndex) {
Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
@@ -198,6 +204,12 @@ public BigDecimal getBigDecimal(int columnIndex) {
return delegate.getBigDecimal(columnIndex);
}
+ @Override
+ public float getFloat(String columnName) {
+ Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
+ return delegate.getFloat(columnName);
+ }
+
@Override
public double getDouble(String columnName) {
Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
@@ -336,6 +348,30 @@ public List getLongList(String columnName) {
return delegate.getLongList(columnName);
}
+ @Override
+ public float[] getFloatArray(int columnIndex) {
+ Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
+ return delegate.getFloatArray(columnIndex);
+ }
+
+ @Override
+ public float[] getFloatArray(String columnName) {
+ Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
+ return delegate.getFloatArray(columnName);
+ }
+
+ @Override
+ public List getFloatList(int columnIndex) {
+ Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
+ return delegate.getFloatList(columnIndex);
+ }
+
+ @Override
+ public List getFloatList(String columnName) {
+ Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
+ return delegate.getFloatList(columnName);
+ }
+
@Override
public double[] getDoubleArray(int columnIndex) {
Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ReplaceableForwardingResultSet.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ReplaceableForwardingResultSet.java
index a8de14e512..bd7c794a0f 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ReplaceableForwardingResultSet.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ReplaceableForwardingResultSet.java
@@ -189,6 +189,18 @@ public long getLong(String columnName) {
return delegate.getLong(columnName);
}
+ @Override
+ public float getFloat(int columnIndex) {
+ checkClosed();
+ return delegate.getFloat(columnIndex);
+ }
+
+ @Override
+ public float getFloat(String columnName) {
+ checkClosed();
+ return delegate.getFloat(columnName);
+ }
+
@Override
public double getDouble(int columnIndex) {
checkClosed();
@@ -345,6 +357,30 @@ public List getLongList(String columnName) {
return delegate.getLongList(columnName);
}
+ @Override
+ public float[] getFloatArray(int columnIndex) {
+ checkClosed();
+ return delegate.getFloatArray(columnIndex);
+ }
+
+ @Override
+ public float[] getFloatArray(String columnName) {
+ checkClosed();
+ return delegate.getFloatArray(columnName);
+ }
+
+ @Override
+ public List getFloatList(int columnIndex) {
+ checkClosed();
+ return delegate.getFloatList(columnIndex);
+ }
+
+ @Override
+ public List getFloatList(String columnName) {
+ checkClosed();
+ return delegate.getFloatList(columnName);
+ }
+
@Override
public double[] getDoubleArray(int columnIndex) {
checkClosed();
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/AbstractStructReaderTypesTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/AbstractStructReaderTypesTest.java
index 4fc3c67ceb..16dd51a36a 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/AbstractStructReaderTypesTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/AbstractStructReaderTypesTest.java
@@ -58,6 +58,11 @@ protected long getLongInternal(int columnIndex) {
return 0;
}
+ @Override
+ protected float getFloatInternal(int columnIndex) {
+ return 0f;
+ }
+
@Override
protected double getDoubleInternal(int columnIndex) {
return 0;
@@ -134,6 +139,16 @@ protected List getLongListInternal(int columnIndex) {
return null;
}
+ @Override
+ protected float[] getFloatArrayInternal(int columnIndex) {
+ return null;
+ }
+
+ @Override
+ protected List getFloatListInternal(int columnIndex) {
+ return null;
+ }
+
@Override
protected double[] getDoubleArrayInternal(int columnIndex) {
return null;
@@ -222,6 +237,13 @@ public static Collection parameters() {
Collections.singletonList("getValue")
},
{Type.int64(), "getLongInternal", 123L, "getLong", Collections.singletonList("getValue")},
+ {
+ Type.float32(),
+ "getFloatInternal",
+ 2.0f,
+ "getFloat",
+ Collections.singletonList("getValue")
+ },
{
Type.float64(),
"getDoubleInternal",
@@ -306,6 +328,20 @@ public static Collection parameters() {
"getLongList",
Arrays.asList("getLongArray", "getValue")
},
+ {
+ Type.array(Type.float32()),
+ "getFloatArrayInternal",
+ new float[] {1.0f, 2.0f},
+ "getFloatArray",
+ Arrays.asList("getFloatList", "getValue")
+ },
+ {
+ Type.array(Type.float32()),
+ "getFloatListInternal",
+ Arrays.asList(2.0f, 4.0f),
+ "getFloatList",
+ Arrays.asList("getFloatArray", "getValue")
+ },
{
Type.array(Type.float64()),
"getDoubleArrayInternal",
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/GrpcResultSetTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/GrpcResultSetTest.java
index cb73618d99..5e6a4ffc2c 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/GrpcResultSetTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/GrpcResultSetTest.java
@@ -537,6 +537,8 @@ public void serialization() {
Value.int64(null),
Value.float64(1.0),
Value.float64(null),
+ Value.float32(1.0f),
+ Value.float32(null),
Value.bytes(ByteArray.fromBase64("abcd")),
Value.bytesFromBase64(
Base64.getEncoder().encodeToString("test".getBytes(StandardCharsets.UTF_8))),
@@ -554,6 +556,8 @@ public void serialization() {
Value.int64Array((long[]) null),
Value.float64Array(new double[] {1.1, 2.2, 3.3}),
Value.float64Array((double[]) null),
+ Value.float32Array(new float[] {1.1f, 2.2f, 3.3f}),
+ Value.float32Array((float[]) null),
Value.bytesArray(Arrays.asList(ByteArray.fromBase64("abcd"), null)),
Value.bytesArrayFromBase64(
Arrays.asList(
@@ -655,6 +659,22 @@ public void getDouble() {
assertThat(resultSet.getDouble(0)).isWithin(0.0).of(Double.MAX_VALUE);
}
+ @Test
+ public void getFloat() {
+ consumer.onPartialResultSet(
+ PartialResultSet.newBuilder()
+ .setMetadata(makeMetadata(Type.struct(Type.StructField.of("f", Type.float32()))))
+ .addValues(Value.float32(Float.MIN_VALUE).toProto())
+ .addValues(Value.float32(Float.MAX_VALUE).toProto())
+ .build());
+ consumer.onCompleted();
+
+ assertThat(resultSet.next()).isTrue();
+ assertThat(resultSet.getFloat(0)).isWithin(0.0f).of(Float.MIN_VALUE);
+ assertThat(resultSet.next()).isTrue();
+ assertThat(resultSet.getFloat(0)).isWithin(0.0f).of(Float.MAX_VALUE);
+ }
+
@Test
public void getBigDecimal() {
consumer.onPartialResultSet(
@@ -877,6 +897,25 @@ public void getDoubleArray() {
.inOrder();
}
+ @Test
+ public void getFloatArray() {
+ float[] floatArray = {Float.MAX_VALUE, Float.MIN_VALUE, 111, 333, 444, 0, -1, -2234};
+
+ consumer.onPartialResultSet(
+ PartialResultSet.newBuilder()
+ .setMetadata(
+ makeMetadata(Type.struct(Type.StructField.of("f", Type.array(Type.float32())))))
+ .addValues(Value.float32Array(floatArray).toProto())
+ .build());
+ consumer.onCompleted();
+
+ assertThat(resultSet.next()).isTrue();
+ assertThat(resultSet.getFloatArray(0))
+ .usingTolerance(0.0)
+ .containsExactly(floatArray)
+ .inOrder();
+ }
+
@Test
public void getBigDecimalList() {
List bigDecimalsList = new ArrayList<>();
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/MockSpannerServiceImpl.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/MockSpannerServiceImpl.java
index f27aa405aa..3b0b7812d2 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/MockSpannerServiceImpl.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/MockSpannerServiceImpl.java
@@ -1284,6 +1284,8 @@ private Statement buildStatement(
case DATE:
builder.bind(fieldName).toDateArray(null);
break;
+ case FLOAT32:
+ builder.bind(fieldName).toFloat32Array((Iterable) null);
case FLOAT64:
builder.bind(fieldName).toFloat64Array((Iterable) null);
break;
@@ -1327,6 +1329,8 @@ private Statement buildStatement(
case DATE:
builder.bind(fieldName).to((Date) null);
break;
+ case FLOAT32:
+ builder.bind(fieldName).to((Float) null);
case FLOAT64:
builder.bind(fieldName).to((Double) null);
break;
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/MutationTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/MutationTest.java
index f38b5e47b8..0cfb57d4a2 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/MutationTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/MutationTest.java
@@ -211,12 +211,37 @@ public void equalsAndHashCode() {
Mutation.delete("T1", KeySet.singleKey(Key.of("k"))), Mutation.delete("T1", Key.of("k")));
// Test NaNs
+ // Refer the comment in `Value.hashCode()` for more details on NaN equality.
tester.addEqualityGroup(
Mutation.newInsertBuilder("T1").set("C").to(Double.NaN).build(),
Mutation.newInsertBuilder("T1").set("C").to(Value.float64(Double.NaN)).build(),
Mutation.newInsertBuilder("T1").set("C").to(Float.NaN).build(),
- Mutation.newInsertBuilder("T1").set("C").to(Value.float64(Float.NaN)).build());
+ Mutation.newInsertBuilder("T1").set("C").to(Value.float64(Float.NaN)).build(),
+ Mutation.newInsertBuilder("T1").set("C").to(Value.float32(Float.NaN)).build());
+ // Test NaN arrays
+ tester.addEqualityGroup(
+ Mutation.newInsertBuilder("T1").set("C").toFloat32Array(new float[] {Float.NaN}).build(),
+ Mutation.newInsertBuilder("T1")
+ .set("C")
+ .toFloat32Array(new float[] {Float.NaN}, 0, 1)
+ .build(),
+ Mutation.newInsertBuilder("T1")
+ .set("C")
+ .toFloat32Array(Collections.singletonList(Float.NaN))
+ .build(),
+ Mutation.newInsertBuilder("T1")
+ .set("C")
+ .to(Value.float32Array(new float[] {Float.NaN}))
+ .build(),
+ Mutation.newInsertBuilder("T1")
+ .set("C")
+ .to(Value.float32Array(new float[] {Float.NaN}, 0, 1))
+ .build(),
+ Mutation.newInsertBuilder("T1")
+ .set("C")
+ .to(Value.float32Array(Collections.singletonList(Float.NaN)))
+ .build());
tester.addEqualityGroup(
Mutation.newInsertBuilder("T1").set("C").toFloat64Array(new double[] {Double.NaN}).build(),
Mutation.newInsertBuilder("T1").set("C").toFloat64Array(new double[] {Float.NaN}).build(),
@@ -270,6 +295,11 @@ public void equalsAndHashCode() {
.set("C")
.toFloat64Array(Arrays.asList(null, (double) Float.NaN))
.build());
+ tester.addEqualityGroup(
+ Mutation.newInsertBuilder("T1")
+ .set("C")
+ .toFloat32Array(Arrays.asList(null, Float.NaN))
+ .build());
tester.testEquals();
}
@@ -523,11 +553,17 @@ private Mutation.WriteBuilder appendAllTypes(Mutation.WriteBuilder builder) {
.to((Long) null)
.set("intValue")
.to(Value.int64(1L))
- .set("float")
+ .set("float32")
+ .to(42.1f)
+ .set("float32Null")
+ .to((Float) null)
+ .set("float32Value")
+ .to(Value.float32(10f))
+ .set("float64")
.to(42.1)
- .set("floatNull")
+ .set("float64Null")
.to((Double) null)
- .set("floatValue")
+ .set("float64Value")
.to(Value.float64(10D))
.set("string")
.to("str")
@@ -583,11 +619,17 @@ private Mutation.WriteBuilder appendAllTypes(Mutation.WriteBuilder builder) {
.toInt64Array((long[]) null)
.set("intArrValue")
.to(Value.int64Array(ImmutableList.of(1L, 2L)))
- .set("floatArr")
+ .set("float32Arr")
+ .toFloat32Array(new float[] {1.1f, 2.2f, 3.3f})
+ .set("float32ArrNull")
+ .toFloat32Array((float[]) null)
+ .set("float32ArrValue")
+ .to(Value.float32Array(ImmutableList.of(10.1F, 10.2F, 10.3F)))
+ .set("float64Arr")
.toFloat64Array(new double[] {1.1, 2.2, 3.3})
- .set("floatArrNull")
+ .set("float64ArrNull")
.toFloat64Array((double[]) null)
- .set("floatArrValue")
+ .set("float64ArrValue")
.to(Value.float64Array(ImmutableList.of(10.1D, 10.2D, 10.3D)))
.set("stringArr")
.toStringArray(ImmutableList.of("one", "two"))
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/RandomResultSetGenerator.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/RandomResultSetGenerator.java
index b5bbb9dd49..6cf1d0900a 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/RandomResultSetGenerator.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/RandomResultSetGenerator.java
@@ -37,6 +37,7 @@ public class RandomResultSetGenerator {
Type.newBuilder().setCode(TypeCode.BOOL).build(),
Type.newBuilder().setCode(TypeCode.INT64).build(),
Type.newBuilder().setCode(TypeCode.FLOAT64).build(),
+ Type.newBuilder().setCode(TypeCode.FLOAT32).build(),
Type.newBuilder().setCode(TypeCode.STRING).build(),
Type.newBuilder().setCode(TypeCode.BYTES).build(),
Type.newBuilder().setCode(TypeCode.DATE).build(),
@@ -53,6 +54,10 @@ public class RandomResultSetGenerator {
.setCode(TypeCode.ARRAY)
.setArrayElementType(Type.newBuilder().setCode(TypeCode.FLOAT64))
.build(),
+ Type.newBuilder()
+ .setCode(TypeCode.ARRAY)
+ .setArrayElementType(Type.newBuilder().setCode(TypeCode.FLOAT32))
+ .build(),
Type.newBuilder()
.setCode(TypeCode.ARRAY)
.setArrayElementType(Type.newBuilder().setCode(TypeCode.STRING))
@@ -138,6 +143,9 @@ private void setRandomValue(Value.Builder builder, Type type) {
case FLOAT64:
builder.setNumberValue(random.nextDouble());
break;
+ case FLOAT32:
+ builder.setNumberValue(random.nextFloat());
+ break;
case INT64:
builder.setStringValue(String.valueOf(random.nextLong()));
break;
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ReadAsyncTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ReadAsyncTest.java
index bb8d130914..6801c82b66 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ReadAsyncTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ReadAsyncTest.java
@@ -298,9 +298,12 @@ public void readOnlyTransaction() throws Exception {
values2 = rs.toListAsync(input -> input.getString("Value"), executor);
}
}
+
+ ApiFuture>> allValuesAsList =
+ ApiFutures.allAsList(Arrays.asList(values1, values2));
ApiFuture> allValues =
ApiFutures.transform(
- ApiFutures.allAsList(Arrays.asList(values1, values2)),
+ allValuesAsList,
input ->
Iterables.mergeSorted(
input,
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ReadFormatTestRunner.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ReadFormatTestRunner.java
index a72c9872fa..8d97d9d894 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ReadFormatTestRunner.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ReadFormatTestRunner.java
@@ -170,6 +170,9 @@ private void assertRow(Struct actualRow, JSONArray expectedRow) throws Exception
case INT64:
assertThat(actualRow.getLong(i)).isEqualTo(expectedRow.getLong(i));
break;
+ case FLOAT32:
+ assertThat(actualRow.getFloat(i)).isEqualTo(expectedRow.getFloat(i));
+ break;
case FLOAT64:
assertThat(actualRow.getDouble(i)).isEqualTo(expectedRow.getDouble(i));
break;
@@ -208,6 +211,9 @@ private List getRawList(Struct actualRow, int index, Type elementType) {
case INT64:
rawList = actualRow.getLongList(index);
break;
+ case FLOAT32:
+ rawList = actualRow.getFloatList(index);
+ break;
case FLOAT64:
rawList = actualRow.getDoubleList(index);
break;
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ResultSetsTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ResultSetsTest.java
index 8e1f257594..454bd3c70a 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ResultSetsTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ResultSetsTest.java
@@ -31,6 +31,7 @@
import com.google.cloud.spanner.SingerProto.Genre;
import com.google.cloud.spanner.SingerProto.SingerInfo;
import com.google.common.primitives.Doubles;
+import com.google.common.primitives.Floats;
import com.google.common.primitives.Longs;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.protobuf.AbstractMessage;
@@ -53,6 +54,7 @@ public class ResultSetsTest {
@Test
public void resultSetIteration() {
double doubleVal = 1.2;
+ float floatVal = 6.626f;
BigDecimal bigDecimalVal = BigDecimal.valueOf(123, 2);
String stringVal = "stringVal";
String jsonVal = "{\"color\":\"red\",\"value\":\"#f00\"}";
@@ -71,6 +73,7 @@ public void resultSetIteration() {
boolean[] boolArray = {true, false, true, true, false};
long[] longArray = {Long.MAX_VALUE, Long.MIN_VALUE, 0, 1, -1};
double[] doubleArray = {Double.MIN_VALUE, Double.MAX_VALUE, 0, 1, -1, 1.2341};
+ float[] floatArray = {Float.MIN_VALUE, Float.MAX_VALUE, 0, 1, -1, 1.2341f};
BigDecimal[] bigDecimalArray = {
BigDecimal.valueOf(1, Integer.MAX_VALUE),
BigDecimal.valueOf(1, Integer.MIN_VALUE),
@@ -102,6 +105,7 @@ public void resultSetIteration() {
Type.StructField.of("f2", Type.int64()),
Type.StructField.of("f3", Type.bool()),
Type.StructField.of("doubleVal", Type.float64()),
+ Type.StructField.of("floatVal", Type.float32()),
Type.StructField.of("bigDecimalVal", Type.numeric()),
Type.StructField.of("stringVal", Type.string()),
Type.StructField.of("jsonVal", Type.json()),
@@ -116,6 +120,7 @@ public void resultSetIteration() {
Type.StructField.of("boolArray", Type.array(Type.bool())),
Type.StructField.of("longArray", Type.array(Type.int64())),
Type.StructField.of("doubleArray", Type.array(Type.float64())),
+ Type.StructField.of("floatArray", Type.array(Type.float32())),
Type.StructField.of("bigDecimalArray", Type.array(Type.numeric())),
Type.StructField.of("byteArray", Type.array(Type.bytes())),
Type.StructField.of("timestampArray", Type.array(Type.timestamp())),
@@ -138,6 +143,8 @@ public void resultSetIteration() {
.to(Value.bool(true))
.set("doubleVal")
.to(Value.float64(doubleVal))
+ .set("floatVal")
+ .to(Value.float32(floatVal))
.set("bigDecimalVal")
.to(Value.numeric(bigDecimalVal))
.set("stringVal")
@@ -162,6 +169,8 @@ public void resultSetIteration() {
.to(Value.int64Array(longArray))
.set("doubleArray")
.to(Value.float64Array(doubleArray))
+ .set("floatArray")
+ .to(Value.float32Array(floatArray))
.set("bigDecimalArray")
.to(Value.numericArray(Arrays.asList(bigDecimalArray)))
.set("byteArray")
@@ -195,6 +204,8 @@ public void resultSetIteration() {
.to(Value.bool(null))
.set("doubleVal")
.to(Value.float64(doubleVal))
+ .set("floatVal")
+ .to(Value.float32(floatVal))
.set("bigDecimalVal")
.to(Value.numeric(bigDecimalVal))
.set("stringVal")
@@ -219,6 +230,8 @@ public void resultSetIteration() {
.to(Value.int64Array(longArray))
.set("doubleArray")
.to(Value.float64Array(doubleArray))
+ .set("floatArray")
+ .to(Value.float32Array(floatArray))
.set("bigDecimalArray")
.to(Value.numericArray(Arrays.asList(bigDecimalArray)))
.set("byteArray")
@@ -274,6 +287,10 @@ public void resultSetIteration() {
assertThat(rs.getValue("doubleVal").getFloat64()).isWithin(0.0).of(doubleVal);
assertThat(rs.getDouble(columnIndex)).isWithin(0.0).of(doubleVal);
assertThat(rs.getValue(columnIndex++).getFloat64()).isWithin(0.0).of(doubleVal);
+ assertThat(rs.getFloat(columnIndex)).isWithin(0.0f).of(floatVal);
+ assertThat(rs.getValue(columnIndex++).getFloat32()).isWithin(0.0f).of(floatVal);
+ assertThat(rs.getFloat("floatVal")).isWithin(0.0f).of(floatVal);
+ assertThat(rs.getValue("floatVal").getFloat32()).isWithin(0.0f).of(floatVal);
assertThat(rs.getBigDecimal("bigDecimalVal")).isEqualTo(new BigDecimal("1.23"));
assertThat(rs.getValue("bigDecimalVal")).isEqualTo(Value.numeric(new BigDecimal("1.23")));
assertThat(rs.getBigDecimal(columnIndex)).isEqualTo(new BigDecimal("1.23"));
@@ -338,6 +355,17 @@ public void resultSetIteration() {
assertThat(rs.getValue("doubleArray")).isEqualTo(Value.float64Array(doubleArray));
assertThat(rs.getDoubleList(columnIndex++)).isEqualTo(Doubles.asList(doubleArray));
assertThat(rs.getDoubleList("doubleArray")).isEqualTo(Doubles.asList(doubleArray));
+
+ assertThat(rs.getFloatArray(columnIndex)).usingTolerance(0.0f).containsAtLeast(floatArray);
+ assertThat(rs.getValue(columnIndex)).isEqualTo(Value.float32Array(floatArray));
+ assertThat(rs.getFloatArray("floatArray"))
+ .usingTolerance(0.0f)
+ .containsExactly(floatArray)
+ .inOrder();
+ assertThat(rs.getValue("floatArray")).isEqualTo(Value.float32Array(floatArray));
+ assertThat(rs.getFloatList(columnIndex++)).isEqualTo(Floats.asList(floatArray));
+ assertThat(rs.getFloatList("floatArray")).isEqualTo(Floats.asList(floatArray));
+
assertThat(rs.getBigDecimalList(columnIndex)).isEqualTo(Arrays.asList(bigDecimalArray));
assertThat(rs.getValue(columnIndex++))
.isEqualTo(Value.numericArray(Arrays.asList(bigDecimalArray)));
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/TypeTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/TypeTest.java
index 11b708ed48..6eedc058c5 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/TypeTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/TypeTest.java
@@ -110,6 +110,16 @@ Type newType() {
}.test();
}
+ @Test
+ public void float32() {
+ new ScalarTypeTester(Type.Code.FLOAT32, TypeCode.FLOAT32) {
+ @Override
+ Type newType() {
+ return Type.float32();
+ }
+ }.test();
+ }
+
@Test
public void float64() {
new ScalarTypeTester(Type.Code.FLOAT64, TypeCode.FLOAT64) {
@@ -307,6 +317,16 @@ Type newElementType() {
}.test();
}
+ @Test
+ public void float32Array() {
+ new ArrayTypeTester(Type.Code.FLOAT32, TypeCode.FLOAT32, true) {
+ @Override
+ Type newElementType() {
+ return Type.float32();
+ }
+ }.test();
+ }
+
@Test
public void float64Array() {
new ArrayTypeTester(Type.Code.FLOAT64, TypeCode.FLOAT64, true) {
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ValueBinderTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ValueBinderTest.java
index d50814e84d..204880bf7d 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ValueBinderTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ValueBinderTest.java
@@ -265,6 +265,14 @@ public static Long defaultLongWrapper() {
return 1234L;
}
+ public static float defaultFloatPrimitive() {
+ return 1.0f;
+ }
+
+ public static Float defaultFloatWrapper() {
+ return 1.0f;
+ }
+
public static double defaultDoublePrimitive() {
return 1.0;
}
@@ -329,6 +337,14 @@ public static Iterable defaultLongIterable() {
return Arrays.asList(1L, 2L);
}
+ public static float[] defaultFloatArray() {
+ return new float[] {1.0f, 2.0f};
+ }
+
+ public static Iterable defaultFloatIterable() {
+ return Arrays.asList(1.0f, 2.0f);
+ }
+
public static double[] defaultDoubleArray() {
return new double[] {1.0, 2.0};
}
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ValueTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ValueTest.java
index 5176013cf3..d692fc44e7 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ValueTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ValueTest.java
@@ -185,6 +185,37 @@ public void int64WrapperNull() {
assertEquals("NULL", v.getAsString());
}
+ @Test
+ public void float32() {
+ Value v = Value.float32(1.23f);
+ assertThat(v.getType()).isEqualTo(Type.float32());
+ assertThat(v.isNull()).isFalse();
+ assertThat(v.getFloat32()).isWithin(0.0001f).of(1.23f);
+ assertThat(v.toString()).isEqualTo("1.23");
+ assertEquals("1.23", v.getAsString());
+ }
+
+ @Test
+ public void float32Wrapper() {
+ Value v = Value.float32(Float.valueOf(1.23f));
+ assertThat(v.getType()).isEqualTo(Type.float32());
+ assertThat(v.isNull()).isFalse();
+ assertThat(v.getFloat32()).isWithin(0.0001f).of(1.23f);
+ assertThat(v.toString()).isEqualTo("1.23");
+ assertEquals("1.23", v.getAsString());
+ }
+
+ @Test
+ public void float32WrapperNull() {
+ Value v = Value.float32(null);
+ assertThat(v.getType()).isEqualTo(Type.float32());
+ assertThat(v.isNull()).isTrue();
+ assertThat(v.toString()).isEqualTo(NULL_STRING);
+ IllegalStateException e = assertThrows(IllegalStateException.class, v::getFloat32);
+ assertThat(e.getMessage()).contains("null value");
+ assertEquals("NULL", v.getAsString());
+ }
+
@Test
public void float64() {
Value v = Value.float64(1.23);
@@ -863,6 +894,60 @@ public void int64ArrayNullTryGetBool() {
assertThat(e.getMessage()).contains("Expected: BOOL actual: ARRAY");
}
+ @Test
+ public void float32Array() {
+ Value v = Value.float32Array(new float[] {.1f, .2f});
+ assertThat(v.isNull()).isFalse();
+ assertThat(v.getFloat32Array()).containsExactly(.1f, .2f).inOrder();
+ assertThat(v.toString()).isEqualTo("[0.1,0.2]");
+ assertEquals("[0.1,0.2]", v.getAsString());
+ }
+
+ @Test
+ public void float32ArrayRange() {
+ Value v = Value.float32Array(new float[] {.1f, .2f, .3f, .4f, .5f}, 1, 3);
+ assertThat(v.isNull()).isFalse();
+ assertThat(v.getFloat32Array()).containsExactly(.2f, .3f, .4f).inOrder();
+ assertThat(v.toString()).isEqualTo("[0.2,0.3,0.4]");
+ assertEquals("[0.2,0.3,0.4]", v.getAsString());
+ }
+
+ @Test
+ public void float32ArrayNull() {
+ Value v = Value.float32Array((float[]) null);
+ assertThat(v.isNull()).isTrue();
+ assertThat(v.toString()).isEqualTo(NULL_STRING);
+ IllegalStateException e = assertThrows(IllegalStateException.class, v::getFloat32Array);
+ assertThat(e.getMessage()).contains("null value");
+ assertEquals("NULL", v.getAsString());
+ }
+
+ @Test
+ public void float32ArrayWrapper() {
+ Value v = Value.float32Array(Arrays.asList(.1f, null, .3f));
+ assertThat(v.isNull()).isFalse();
+ assertThat(v.getFloat32Array()).containsExactly(.1f, null, .3f).inOrder();
+ assertThat(v.toString()).isEqualTo("[0.1,NULL,0.3]");
+ assertEquals("[0.1,NULL,0.3]", v.getAsString());
+ }
+
+ @Test
+ public void float32ArrayWrapperNull() {
+ Value v = Value.float32Array((Iterable) null);
+ assertThat(v.isNull()).isTrue();
+ assertThat(v.toString()).isEqualTo(NULL_STRING);
+ IllegalStateException e = assertThrows(IllegalStateException.class, v::getFloat32Array);
+ assertThat(e.getMessage()).contains("null value");
+ assertEquals("NULL", v.getAsString());
+ }
+
+ @Test
+ public void float32ArrayTryGetFloat64Array() {
+ Value value = Value.float32Array(Collections.singletonList(.1f));
+ IllegalStateException e = assertThrows(IllegalStateException.class, value::getFloat64Array);
+ assertThat(e.getMessage()).contains("Expected: ARRAY actual: ARRAY");
+ }
+
@Test
public void float64Array() {
Value v = Value.float64Array(new double[] {.1, .2});
@@ -1426,6 +1511,13 @@ public void testValueToProto() {
com.google.protobuf.Value.newBuilder().setNullValue(NullValue.NULL_VALUE).build(),
Value.int64(null).toProto());
+ assertEquals(
+ com.google.protobuf.Value.newBuilder().setNumberValue(3.14f).build(),
+ Value.float32(3.14f).toProto());
+ assertEquals(
+ com.google.protobuf.Value.newBuilder().setNullValue(NullValue.NULL_VALUE).build(),
+ Value.float32(null).toProto());
+
assertEquals(
com.google.protobuf.Value.newBuilder().setNumberValue(3.14d).build(),
Value.float64(3.14d).toProto());
@@ -1512,6 +1604,18 @@ public void testValueToProto() {
.build())))
.build(),
Value.int64Array(Arrays.asList(1L, null)).toProto());
+ assertEquals(
+ com.google.protobuf.Value.newBuilder()
+ .setListValue(
+ ListValue.newBuilder()
+ .addAllValues(
+ Arrays.asList(
+ com.google.protobuf.Value.newBuilder().setNumberValue(3.14f).build(),
+ com.google.protobuf.Value.newBuilder()
+ .setNullValue(NullValue.NULL_VALUE)
+ .build())))
+ .build(),
+ Value.float32Array(Arrays.asList(3.14f, null)).toProto());
assertEquals(
com.google.protobuf.Value.newBuilder()
.setListValue(
@@ -1667,6 +1771,29 @@ public void testValueToProto() {
.build(),
Value.struct(Struct.newBuilder().add(Value.int64Array(Arrays.asList(1L, null))).build())
.toProto());
+ assertEquals(
+ com.google.protobuf.Value.newBuilder()
+ .setListValue(
+ ListValue.newBuilder()
+ .addValues(
+ com.google.protobuf.Value.newBuilder()
+ .setListValue(
+ ListValue.newBuilder()
+ .addAllValues(
+ Arrays.asList(
+ com.google.protobuf.Value.newBuilder()
+ .setNumberValue(3.14f)
+ .build(),
+ com.google.protobuf.Value.newBuilder()
+ .setNullValue(NullValue.NULL_VALUE)
+ .build()))
+ .build())
+ .build())
+ .build())
+ .build(),
+ Value.struct(
+ Struct.newBuilder().add(Value.float32Array(Arrays.asList(3.14f, null))).build())
+ .toProto());
assertEquals(
com.google.protobuf.Value.newBuilder()
.setListValue(
@@ -1872,6 +1999,10 @@ public void testEqualsHashCode() {
tester.addEqualityGroup(Value.int64(456));
tester.addEqualityGroup(Value.int64(null));
+ tester.addEqualityGroup(Value.float32(1.23f), Value.float32(Float.valueOf(1.23f)));
+ tester.addEqualityGroup(Value.float32(4.56f));
+ tester.addEqualityGroup(Value.float32(null));
+
tester.addEqualityGroup(Value.float64(1.23), Value.float64(Double.valueOf(1.23)));
tester.addEqualityGroup(Value.float64(4.56));
tester.addEqualityGroup(Value.float64(null));
@@ -1938,6 +2069,14 @@ public void testEqualsHashCode() {
tester.addEqualityGroup(Value.int64Array(Collections.singletonList(3L)));
tester.addEqualityGroup(Value.int64Array((Iterable) null));
+ tester.addEqualityGroup(
+ Value.float32Array(Arrays.asList(.1f, .2f)),
+ Value.float32Array(new float[] {.1f, .2f}),
+ Value.float32Array(new float[] {.0f, .1f, .2f, .3f}, 1, 2),
+ Value.float32Array(plainIterable(.1f, .2f)));
+ tester.addEqualityGroup(Value.float32Array(Collections.singletonList(.3f)));
+ tester.addEqualityGroup(Value.float32Array((Iterable) null));
+
tester.addEqualityGroup(
Value.float64Array(Arrays.asList(.1, .2)),
Value.float64Array(new double[] {.1, .2}),
@@ -2009,6 +2148,11 @@ public void testGetAsString() {
assertEquals(String.valueOf(Long.MAX_VALUE), Value.int64(Long.MAX_VALUE).getAsString());
assertEquals(String.valueOf(Long.MIN_VALUE), Value.int64(Long.MIN_VALUE).getAsString());
+ assertEquals("3.14", Value.float32(3.14f).getAsString());
+ assertEquals("NaN", Value.float32(Float.NaN).getAsString());
+ assertEquals(String.valueOf(Float.MIN_VALUE), Value.float32(Float.MIN_VALUE).getAsString());
+ assertEquals(String.valueOf(Float.MAX_VALUE), Value.float32(Float.MAX_VALUE).getAsString());
+
assertEquals("3.14", Value.float64(3.14d).getAsString());
assertEquals("NaN", Value.float64(Double.NaN).getAsString());
assertEquals(String.valueOf(Double.MIN_VALUE), Value.float64(Double.MIN_VALUE).getAsString());
@@ -2052,6 +2196,9 @@ public void serialization() {
reserializeAndAssert(Value.int64(123));
reserializeAndAssert(Value.int64(null));
+ reserializeAndAssert(Value.float32(1.23f));
+ reserializeAndAssert(Value.float32(null));
+
reserializeAndAssert(Value.float64(1.23));
reserializeAndAssert(Value.float64(null));
@@ -2089,6 +2236,10 @@ public void serialization() {
reserializeAndAssert(Value.int64Array(new long[] {1L, 2L}));
reserializeAndAssert(Value.int64Array((Iterable) null));
+ reserializeAndAssert(Value.float32Array(new float[] {.1f, .2f}));
+ reserializeAndAssert(Value.float32Array(BrokenSerializationList.of(.1f, .2f, .3f)));
+ reserializeAndAssert(Value.float32Array((Iterable) null));
+
reserializeAndAssert(Value.float64Array(new double[] {.1, .2}));
reserializeAndAssert(Value.float64Array(BrokenSerializationList.of(.1, .2, .3)));
reserializeAndAssert(Value.float64Array((Iterable) null));
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/ChecksumResultSetTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/ChecksumResultSetTest.java
index 4e8fb0cfcb..759f058aa0 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/ChecksumResultSetTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/ChecksumResultSetTest.java
@@ -57,6 +57,8 @@ public class ChecksumResultSetTest {
.to(2 * 2)
.set("doubleVal")
.to(Value.float64(3.14d * 2d))
+ .set("floatVal")
+ .to(Value.float32(3.14f * 3f))
.set("bigDecimalVal")
.to(Value.numeric(BigDecimal.valueOf(123 * 2, 2)))
.set("pgNumericVal")
@@ -83,6 +85,8 @@ public class ChecksumResultSetTest {
.to(Value.int64Array(Arrays.asList(2L, null, 1L, 0L)))
.set("doubleArray")
.to(Value.float64Array(Arrays.asList(3.14d, null, 6.6626d, 10.1d)))
+ .set("floatArray")
+ .to(Value.float32Array(Arrays.asList(2.71f, null, 6.6626f, 10.1f)))
.set("bigDecimalArray")
.to(Value.numericArray(Arrays.asList(BigDecimal.TEN, null, BigDecimal.ONE)))
.set("pgNumericArray")
@@ -128,6 +132,7 @@ public void testRetry() {
Type.StructField.of("boolVal", Type.bool()),
Type.StructField.of("longVal", Type.int64()),
Type.StructField.of("doubleVal", Type.float64()),
+ Type.StructField.of("floatVal", Type.float32()),
Type.StructField.of("bigDecimalVal", Type.numeric()),
Type.StructField.of("pgNumericVal", Type.pgNumeric()),
Type.StructField.of("stringVal", Type.string()),
@@ -143,6 +148,7 @@ public void testRetry() {
Type.StructField.of("boolArray", Type.array(Type.bool())),
Type.StructField.of("longArray", Type.array(Type.int64())),
Type.StructField.of("doubleArray", Type.array(Type.float64())),
+ Type.StructField.of("floatArray", Type.array(Type.float32())),
Type.StructField.of("bigDecimalArray", Type.array(Type.numeric())),
Type.StructField.of("pgNumericArray", Type.array(Type.pgNumeric())),
Type.StructField.of("byteArray", Type.array(Type.bytes())),
@@ -164,6 +170,8 @@ public void testRetry() {
.to(2)
.set("doubleVal")
.to(Value.float64(3.14d))
+ .set("floatVal")
+ .to(Value.float32(2.71f))
.set("bigDecimalVal")
.to(Value.numeric(BigDecimal.valueOf(123, 2)))
.set("pgNumericVal")
@@ -190,6 +198,8 @@ public void testRetry() {
.to(Value.int64Array(Arrays.asList(1L, null, 2L)))
.set("doubleArray")
.to(Value.float64Array(Arrays.asList(3.14d, null, 6.6626d)))
+ .set("floatArray")
+ .to(Value.float32Array(Arrays.asList(2.71f, null, 6.6626f)))
.set("bigDecimalArray")
.to(Value.numericArray(Arrays.asList(BigDecimal.ONE, null, BigDecimal.TEN)))
.set("pgNumericArray")
@@ -238,6 +248,8 @@ public void testRetry() {
.to((Long) null)
.set("doubleVal")
.to((Double) null)
+ .set("floatVal")
+ .to((Float) null)
.set("bigDecimalVal")
.to((BigDecimal) null)
.set("pgNumericVal")
@@ -264,6 +276,8 @@ public void testRetry() {
.toInt64Array((Iterable) null)
.set("doubleArray")
.toFloat64Array((Iterable) null)
+ .set("floatArray")
+ .toFloat32Array((Iterable) null)
.set("bigDecimalArray")
.toNumericArray(null)
.set("pgNumericArray")
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITAsyncExamplesTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITAsyncExamplesTest.java
index 5a22c64009..87f26da904 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITAsyncExamplesTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITAsyncExamplesTest.java
@@ -344,9 +344,12 @@ public void readOnlyTransaction() throws Exception {
values2 = rs.toListAsync(input -> input.getString("StringValue"), executor);
}
}
+
+ ApiFuture>> allAsListValues =
+ ApiFutures.allAsList(Arrays.asList(values1, values2));
ApiFuture> allValues =
ApiFutures.transform(
- ApiFutures.allAsList(Arrays.asList(values1, values2)),
+ allAsListValues,
input ->
Iterables.mergeSorted(
input, Comparator.comparing(o -> Integer.valueOf(o.substring(1)))),
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITFloat32Test.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITFloat32Test.java
new file mode 100644
index 0000000000..de2640b86c
--- /dev/null
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITFloat32Test.java
@@ -0,0 +1,415 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.cloud.spanner.it;
+
+import static com.google.cloud.spanner.testing.EmulatorSpannerHelper.isUsingEmulator;
+import static com.google.common.base.Strings.isNullOrEmpty;
+import static org.junit.Assert.assertArrayEquals;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertThrows;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assume.assumeFalse;
+import static org.junit.Assume.assumeTrue;
+
+import com.google.cloud.Timestamp;
+import com.google.cloud.spanner.Database;
+import com.google.cloud.spanner.DatabaseClient;
+import com.google.cloud.spanner.Dialect;
+import com.google.cloud.spanner.IntegrationTestEnv;
+import com.google.cloud.spanner.Key;
+import com.google.cloud.spanner.Mutation;
+import com.google.cloud.spanner.ParallelIntegrationTest;
+import com.google.cloud.spanner.ResultSet;
+import com.google.cloud.spanner.Statement;
+import com.google.cloud.spanner.Struct;
+import com.google.cloud.spanner.TimestampBound;
+import com.google.cloud.spanner.Value;
+import com.google.cloud.spanner.connection.ConnectionOptions;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeoutException;
+import org.junit.AfterClass;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.ClassRule;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+
+@Category(ParallelIntegrationTest.class)
+@RunWith(Parameterized.class)
+public class ITFloat32Test {
+
+ @ClassRule public static IntegrationTestEnv env = new IntegrationTestEnv();
+
+ @Parameterized.Parameters(name = "Dialect = {0}")
+ public static List data() {
+ return Arrays.asList(
+ new DialectTestParameter(Dialect.GOOGLE_STANDARD_SQL),
+ new DialectTestParameter(Dialect.POSTGRESQL));
+ }
+
+ @Parameterized.Parameter() public DialectTestParameter dialect;
+
+ private static DatabaseClient googleStandardSQLClient;
+ private static DatabaseClient postgreSQLClient;
+
+ private static final String[] GOOGLE_STANDARD_SQL_SCHEMA =
+ new String[] {
+ "CREATE TABLE T ("
+ + " Key STRING(MAX) NOT NULL,"
+ + " Float32Value FLOAT32,"
+ + " Float32ArrayValue ARRAY,"
+ + ") PRIMARY KEY (Key)"
+ };
+
+ private static final String[] POSTGRESQL_SCHEMA =
+ new String[] {
+ "CREATE TABLE T ("
+ + " Key VARCHAR PRIMARY KEY,"
+ + " Float32Value REAL,"
+ + " Float32ArrayValue REAL[]"
+ + ")"
+ };
+
+ private static DatabaseClient client;
+
+ private static boolean isUsingCloudDevel() {
+ String jobType = System.getenv("JOB_TYPE");
+
+ // Assumes that the jobType contains the string "cloud-devel" to signal that
+ // the environment is cloud-devel.
+ return !isNullOrEmpty(jobType) && jobType.contains("cloud-devel");
+ }
+
+ @BeforeClass
+ public static void setUpDatabase()
+ throws ExecutionException, InterruptedException, TimeoutException {
+ assumeTrue("FLOAT32 is currently only supported in cloud-devel", isUsingCloudDevel());
+ assumeFalse("Emulator does not support FLOAT32 yet", isUsingEmulator());
+
+ Database googleStandardSQLDatabase =
+ env.getTestHelper().createTestDatabase(GOOGLE_STANDARD_SQL_SCHEMA);
+
+ googleStandardSQLClient = env.getTestHelper().getDatabaseClient(googleStandardSQLDatabase);
+
+ Database postgreSQLDatabase =
+ env.getTestHelper()
+ .createTestDatabase(Dialect.POSTGRESQL, Arrays.asList(POSTGRESQL_SCHEMA));
+ postgreSQLClient = env.getTestHelper().getDatabaseClient(postgreSQLDatabase);
+ }
+
+ @Before
+ public void before() {
+ client =
+ dialect.dialect == Dialect.GOOGLE_STANDARD_SQL ? googleStandardSQLClient : postgreSQLClient;
+ }
+
+ @AfterClass
+ public static void tearDown() throws Exception {
+ ConnectionOptions.closeSpanner();
+ }
+
+ /** Sequence used to generate unique keys. */
+ private static int seq;
+
+ private static String uniqueString() {
+ return String.format("k%04d", seq++);
+ }
+
+ private String lastKey;
+
+ private Timestamp write(Mutation m) {
+ return client.write(Collections.singletonList(m));
+ }
+
+ private Mutation.WriteBuilder baseInsert() {
+ return Mutation.newInsertOrUpdateBuilder("T").set("Key").to(lastKey = uniqueString());
+ }
+
+ private Struct readRow(String table, String key, String... columns) {
+ return client
+ .singleUse(TimestampBound.strong())
+ .readRow(table, Key.of(key), Arrays.asList(columns));
+ }
+
+ private Struct readLastRow(String... columns) {
+ return readRow("T", lastKey, columns);
+ }
+
+ @Test
+ public void writeFloat32() {
+ write(baseInsert().set("Float32Value").to(2.0f).build());
+ Struct row = readLastRow("Float32Value");
+ assertFalse(row.isNull(0));
+ assertEquals(2.0f, row.getFloat(0), 0.0f);
+ }
+
+ @Test
+ public void writeFloat32NonNumbers() {
+
+ write(baseInsert().set("Float32Value").to(Float.NEGATIVE_INFINITY).build());
+ Struct row = readLastRow("Float32Value");
+ assertFalse(row.isNull(0));
+ assertEquals(Float.NEGATIVE_INFINITY, row.getFloat(0), 0.0f);
+
+ write(baseInsert().set("Float32Value").to(Float.POSITIVE_INFINITY).build());
+ row = readLastRow("Float32Value");
+ assertFalse(row.isNull(0));
+ assertEquals(Float.POSITIVE_INFINITY, row.getFloat(0), 0.0);
+
+ write(baseInsert().set("Float32Value").to(Float.NaN).build());
+ row = readLastRow("Float32Value");
+ assertFalse(row.isNull(0));
+ assertTrue(Float.isNaN(row.getFloat(0)));
+ }
+
+ @Test
+ public void writeFloat32Null() {
+ write(baseInsert().set("Float32Value").to((Float) null).build());
+ Struct row = readLastRow("Float32Value");
+ assertTrue(row.isNull(0));
+ }
+
+ @Test
+ public void writeFloat32ArrayNull() {
+ write(baseInsert().set("Float32ArrayValue").toFloat32Array((float[]) null).build());
+ Struct row = readLastRow("Float32ArrayValue");
+ assertTrue(row.isNull(0));
+ }
+
+ @Test
+ public void writeFloat32ArrayEmpty() {
+ write(baseInsert().set("Float32ArrayValue").toFloat32Array(new float[] {}).build());
+ Struct row = readLastRow("Float32ArrayValue");
+ assertFalse(row.isNull(0));
+ assertTrue(row.getFloatList(0).isEmpty());
+ }
+
+ @Test
+ public void writeFloat32Array() {
+ write(
+ baseInsert()
+ .set("Float32ArrayValue")
+ .toFloat32Array(Arrays.asList(null, 1.0f, 2.0f))
+ .build());
+ Struct row = readLastRow("Float32ArrayValue");
+ assertFalse(row.isNull(0));
+ assertEquals(row.getFloatList(0), Arrays.asList(null, 1.0f, 2.0f));
+ assertThrows(NullPointerException.class, () -> row.getFloatArray(0));
+ }
+
+ @Test
+ public void writeFloat32ArrayNoNulls() {
+ write(baseInsert().set("Float32ArrayValue").toFloat32Array(Arrays.asList(1.0f, 2.0f)).build());
+ Struct row = readLastRow("Float32ArrayValue");
+ assertFalse(row.isNull(0));
+ assertEquals(2, row.getFloatArray(0).length);
+ assertEquals(1.0f, row.getFloatArray(0)[0], 0.0f);
+ assertEquals(2.0f, row.getFloatArray(0)[1], 0.0f);
+ }
+
+ private String getInsertStatementWithLiterals() {
+ String statement = "INSERT INTO T (Key, Float32Value, Float32ArrayValue) VALUES ";
+
+ if (dialect.dialect == Dialect.POSTGRESQL) {
+ statement +=
+ "('dml1', 3.14::float8, array[1.1]::float4[]), "
+ + "('dml2', '3.14'::float4, array[3.14::float4, 3.14::float8]::float4[]), "
+ + "('dml3', 'nan'::real, array['inf'::real, (3.14::float8)::float4, 1.2, '-inf']::float4[]), "
+ + "('dml4', 1.175494e-38::real, array[1.175494e-38, 3.4028234e38, -3.4028234e38]::real[]), "
+ + "('dml5', null, null)";
+ } else {
+ statement +=
+ "('dml1', 3.14, [CAST(1.1 AS FLOAT32)]), "
+ + "('dml2', CAST('3.14' AS FLOAT32), array[CAST(3.14 AS FLOAT32), 3.14]), "
+ + "('dml3', CAST('nan' AS FLOAT32), array[CAST('inf' AS FLOAT32), CAST(CAST(3.14 AS FLOAT64) AS FLOAT32), 1.2, CAST('-inf' AS FLOAT32)]), "
+ + "('dml4', 1.175494e-38, [CAST(1.175494e-38 AS FLOAT32), 3.4028234e38, -3.4028234e38]), "
+ + "('dml5', null, null)";
+ }
+ return statement;
+ }
+
+ @Test
+ public void float32Literals() {
+ client
+ .readWriteTransaction()
+ .run(
+ transaction -> {
+ transaction.executeUpdate(Statement.of(getInsertStatementWithLiterals()));
+ return null;
+ });
+
+ verifyContents("dml");
+ }
+
+ private String getInsertStatementWithParameters() {
+ String pgStatement =
+ "INSERT INTO T (Key, Float32Value, Float32ArrayValue) VALUES "
+ + "('param1', $1, $2), "
+ + "('param2', $3, $4), "
+ + "('param3', $5, $6), "
+ + "('param4', $7, $8), "
+ + "('param5', $9, $10)";
+
+ return (dialect.dialect == Dialect.POSTGRESQL) ? pgStatement : pgStatement.replace("$", "@p");
+ }
+
+ @Test
+ public void float32Parameter() {
+ client
+ .readWriteTransaction()
+ .run(
+ transaction -> {
+ transaction.executeUpdate(
+ Statement.newBuilder(getInsertStatementWithParameters())
+ .bind("p1")
+ .to(Value.float32(3.14f))
+ .bind("p2")
+ .to(Value.float32Array(Arrays.asList(1.1f)))
+ .bind("p3")
+ .to(Value.float32(3.14f))
+ .bind("p4")
+ .to(Value.float32Array(new float[] {3.14f, 3.14f}))
+ .bind("p5")
+ .to(Value.float32(Float.NaN))
+ .bind("p6")
+ .to(
+ Value.float32Array(
+ Arrays.asList(
+ Float.POSITIVE_INFINITY, 3.14f, 1.2f, Float.NEGATIVE_INFINITY)))
+ .bind("p7")
+ .to(Value.float32(Float.MIN_NORMAL))
+ .bind("p8")
+ .to(
+ Value.float32Array(
+ Arrays.asList(
+ Float.MIN_NORMAL, Float.MAX_VALUE, -1 * Float.MAX_VALUE)))
+ .bind("p9")
+ .to(Value.float32(null))
+ .bind("p10")
+ .to(Value.float32Array((float[]) null))
+ .build());
+ return null;
+ });
+
+ verifyContents("param");
+ }
+
+ private String getInsertStatementForUntypedParameters() {
+ if (dialect.dialect == Dialect.POSTGRESQL) {
+ return "INSERT INTO T (key, float32value, float32arrayvalue) VALUES "
+ + "('untyped1', ($1)::float4, ($2)::float4[])";
+ }
+ return "INSERT INTO T (Key, Float32Value, Float32ArrayValue) VALUES "
+ + "('untyped1', CAST(@p1 AS FLOAT32), CAST(@p2 AS ARRAY))";
+ }
+
+ @Test
+ public void float32UntypedParameter() {
+ client
+ .readWriteTransaction()
+ .run(
+ transaction -> {
+ transaction.executeUpdate(
+ Statement.newBuilder(getInsertStatementForUntypedParameters())
+ .bind("p1")
+ .to(
+ Value.untyped(
+ com.google.protobuf.Value.newBuilder()
+ .setNumberValue((double) 3.14f)
+ .build()))
+ .bind("p2")
+ .to(
+ Value.untyped(
+ com.google.protobuf.Value.newBuilder()
+ .setListValue(
+ com.google.protobuf.ListValue.newBuilder()
+ .addValues(
+ com.google.protobuf.Value.newBuilder()
+ .setNumberValue((double) Float.MIN_NORMAL)))
+ .build()))
+ .build());
+ return null;
+ });
+
+ Struct row = readRow("T", "untyped1", "Float32Value", "Float32ArrayValue");
+ // Float32Value
+ assertFalse(row.isNull(0));
+ assertEquals(3.14f, row.getFloat(0), 0.00001f);
+ // Float32ArrayValue
+ assertFalse(row.isNull(1));
+ assertEquals(1, row.getFloatList(1).size());
+ assertEquals(Float.MIN_NORMAL, row.getFloatList(1).get(0), 0.00001f);
+ }
+
+ private void verifyContents(String keyPrefix) {
+ try (ResultSet resultSet =
+ client
+ .singleUse()
+ .executeQuery(
+ Statement.of(
+ "SELECT Key AS key, Float32Value AS float32value, Float32ArrayValue AS float32arrayvalue FROM T WHERE Key LIKE '{keyPrefix}%' ORDER BY key"
+ .replace("{keyPrefix}", keyPrefix)))) {
+
+ assertTrue(resultSet.next());
+
+ assertEquals(3.14f, resultSet.getFloat("float32value"), 0.00001f);
+ assertEquals(Value.float32(3.14f), resultSet.getValue("float32value"));
+
+ assertArrayEquals(new float[] {1.1f}, resultSet.getFloatArray("float32arrayvalue"), 0.00001f);
+
+ assertTrue(resultSet.next());
+
+ assertEquals(3.14f, resultSet.getFloat("float32value"), 0.00001f);
+ assertEquals(Arrays.asList(3.14f, 3.14f), resultSet.getFloatList("float32arrayvalue"));
+ assertEquals(
+ Value.float32Array(new float[] {3.14f, 3.14f}), resultSet.getValue("float32arrayvalue"));
+
+ assertTrue(resultSet.next());
+ assertTrue(Float.isNaN(resultSet.getFloat("float32value")));
+ assertTrue(Float.isNaN(resultSet.getValue("float32value").getFloat32()));
+ assertEquals(
+ Arrays.asList(Float.POSITIVE_INFINITY, 3.14f, 1.2f, Float.NEGATIVE_INFINITY),
+ resultSet.getFloatList("float32arrayvalue"));
+ assertEquals(
+ Value.float32Array(
+ Arrays.asList(Float.POSITIVE_INFINITY, 3.14f, 1.2f, Float.NEGATIVE_INFINITY)),
+ resultSet.getValue("float32arrayvalue"));
+
+ assertTrue(resultSet.next());
+ assertEquals(Float.MIN_NORMAL, resultSet.getFloat("float32value"), 0.00001f);
+ assertEquals(Float.MIN_NORMAL, resultSet.getValue("float32value").getFloat32(), 0.00001f);
+ assertEquals(3, resultSet.getFloatList("float32arrayvalue").size());
+ assertEquals(Float.MIN_NORMAL, resultSet.getFloatList("float32arrayvalue").get(0), 0.00001);
+ assertEquals(Float.MAX_VALUE, resultSet.getFloatList("float32arrayvalue").get(1), 0.00001f);
+ assertEquals(
+ -1 * Float.MAX_VALUE, resultSet.getFloatList("float32arrayvalue").get(2), 0.00001f);
+ assertEquals(3, resultSet.getValue("float32arrayvalue").getFloat32Array().size());
+
+ assertTrue(resultSet.next());
+ assertTrue(resultSet.isNull("float32value"));
+ assertTrue(resultSet.isNull("float32arrayvalue"));
+
+ assertFalse(resultSet.next());
+ }
+ }
+}
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITQueryTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITQueryTest.java
index a691fbf78b..170ce75e69 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITQueryTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITQueryTest.java
@@ -17,6 +17,7 @@
package com.google.cloud.spanner.it;
import static com.google.cloud.spanner.testing.EmulatorSpannerHelper.isUsingEmulator;
+import static com.google.common.base.Strings.isNullOrEmpty;
import static com.google.common.truth.Truth.assertThat;
import static java.util.Arrays.asList;
import static org.junit.Assert.assertEquals;
@@ -254,6 +255,36 @@ public void bindInt64Null() {
assertThat(row.isNull(0)).isTrue();
}
+ // TODO: Remove once FLOAT32 is supported in production.
+ private static boolean isUsingCloudDevel() {
+ String jobType = System.getenv("JOB_TYPE");
+
+ // Assumes that the jobType contains the string "cloud-devel" to signal that
+ // the environment is cloud-devel.
+ return !isNullOrEmpty(jobType) && jobType.contains("cloud-devel");
+ }
+
+ @Test
+ public void bindFloat32() {
+ assumeFalse("Emulator does not support FLOAT32 yet", isUsingEmulator());
+ assumeTrue("FLOAT32 is currently only supported in cloud-devel", isUsingCloudDevel());
+
+ Struct row =
+ execute(Statement.newBuilder(selectValueQuery).bind("p1").to(2.0f), Type.float32());
+ assertThat(row.isNull(0)).isFalse();
+ assertThat(row.getFloat(0)).isWithin(0.0f).of(2.0f);
+ }
+
+ @Test
+ public void bindFloat32Null() {
+ assumeFalse("Emulator does not support FLOAT32 yet", isUsingEmulator());
+ assumeTrue("FLOAT32 is currently only supported in cloud-devel", isUsingCloudDevel());
+
+ Struct row =
+ execute(Statement.newBuilder(selectValueQuery).bind("p1").to((Float) null), Type.float32());
+ assertThat(row.isNull(0)).isTrue();
+ }
+
@Test
public void bindFloat64() {
Struct row = execute(Statement.newBuilder(selectValueQuery).bind("p1").to(2.0), Type.float64());
@@ -497,6 +528,58 @@ public void bindInt64ArrayNull() {
assertThat(row.isNull(0)).isTrue();
}
+ @Test
+ public void bindFloat32Array() {
+ assumeFalse("Emulator does not support FLOAT32 yet", isUsingEmulator());
+ assumeTrue("FLOAT32 is currently only supported in cloud-devel", isUsingCloudDevel());
+
+ Struct row =
+ execute(
+ Statement.newBuilder(selectValueQuery)
+ .bind("p1")
+ .toFloat32Array(
+ asList(
+ null,
+ 1.0f,
+ 2.0f,
+ Float.NEGATIVE_INFINITY,
+ Float.POSITIVE_INFINITY,
+ Float.NaN)),
+ Type.array(Type.float32()));
+ assertThat(row.isNull(0)).isFalse();
+ assertThat(row.getFloatList(0))
+ .containsExactly(
+ null, 1.0f, 2.0f, Float.NEGATIVE_INFINITY, Float.POSITIVE_INFINITY, Float.NaN)
+ .inOrder();
+ }
+
+ @Test
+ public void bindFloat32ArrayEmpty() {
+ assumeFalse("Emulator does not support FLOAT32 yet", isUsingEmulator());
+ assumeTrue("FLOAT32 is currently only supported in cloud-devel", isUsingCloudDevel());
+
+ Struct row =
+ execute(
+ Statement.newBuilder(selectValueQuery)
+ .bind("p1")
+ .toFloat32Array(Collections.emptyList()),
+ Type.array(Type.float32()));
+ assertThat(row.isNull(0)).isFalse();
+ assertThat(row.getFloatList(0)).containsExactly();
+ }
+
+ @Test
+ public void bindFloat32ArrayNull() {
+ assumeFalse("Emulator does not support FLOAT32 yet", isUsingEmulator());
+ assumeTrue("FLOAT32 is currently only supported in cloud-devel", isUsingCloudDevel());
+
+ Struct row =
+ execute(
+ Statement.newBuilder(selectValueQuery).bind("p1").toFloat32Array((float[]) null),
+ Type.array(Type.float32()));
+ assertThat(row.isNull(0)).isTrue();
+ }
+
@Test
public void bindFloat64Array() {
Struct row =
From cf865f8dd3f5906805c1481a7e5393d680ea83e3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Knut=20Olav=20L=C3=B8ite?=
Date: Thu, 29 Feb 2024 11:23:34 +0100
Subject: [PATCH 08/16] chore: loosen restrictions setRetryAbortsInternally
(#2924)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
* chore: loosen restrictions setRetryAbortsInternally
Calling setRetryAbortsInternally(boolean) was unnecessarily strict, as there
is no reason why it should be disallowed to change the value while in
auto-commit mode and/or read-only mode. The fact that the flag does not have
any direct impact on those modes, does not mean that it should be disallowed
to set the value.
The fact that it was impossible to set the value while in auto-commit mode,
also means that it is impossible to disable it using a startup command for
a PostgreSQL connection to PGAdapter, as PGAdapter creates connections in
auto-commit mode.
* 🦉 Updates from OwlBot post-processor
See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md
---------
Co-authored-by: Owl Bot
---
.../spanner/connection/ConnectionImpl.java | 4 --
.../connection/ConnectionImplTest.java | 44 +++++++++++++++++++
2 files changed, 44 insertions(+), 4 deletions(-)
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ConnectionImpl.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ConnectionImpl.java
index e9aed66b6b..8ff367b248 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ConnectionImpl.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ConnectionImpl.java
@@ -678,10 +678,6 @@ public void setStatementTag(String tag) {
*/
private void checkSetRetryAbortsInternallyAvailable() {
ConnectionPreconditions.checkState(!isClosed(), CLOSED_ERROR_MSG);
- ConnectionPreconditions.checkState(isInTransaction(), "This connection has no transaction");
- ConnectionPreconditions.checkState(
- getTransactionMode() == TransactionMode.READ_WRITE_TRANSACTION,
- "RetryAbortsInternally is only available for read-write transactions");
ConnectionPreconditions.checkState(
!isTransactionStarted(),
"RetryAbortsInternally cannot be set after the transaction has started");
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/ConnectionImplTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/ConnectionImplTest.java
index 0b54b35225..015927440d 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/ConnectionImplTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/ConnectionImplTest.java
@@ -1863,6 +1863,50 @@ public void testCheckResultTypeAllowed() {
checkResultTypeAllowed(parser.parse(Statement.of(start)), allowedResultTypes);
}
+ @Test
+ public void testSetRetryAbortsInternally() {
+ try (ConnectionImpl connection =
+ createConnection(
+ ConnectionOptions.newBuilder()
+ .setCredentials(NoCredentials.getInstance())
+ .setUri(URI)
+ .build())) {
+ assertFalse("Read-only should be disabled by default", connection.isReadOnly());
+ assertTrue("Autocommit should be enabled by default", connection.isAutocommit());
+ assertFalse(
+ "Retry aborts internally should be disabled by default on test connections",
+ connection.isRetryAbortsInternally());
+
+ // It should be possible to change this value also when in auto-commit mode.
+ connection.setRetryAbortsInternally(true);
+ assertTrue(connection.isRetryAbortsInternally());
+
+ // It should be possible to change this value also when in transactional mode, as long as
+ // there is no active transaction.
+ connection.setAutocommit(false);
+ connection.setRetryAbortsInternally(false);
+ assertFalse(connection.isRetryAbortsInternally());
+
+ // It should be possible to change the value when in read-only mode.
+ connection.setReadOnly(true);
+ connection.setRetryAbortsInternally(true);
+ assertTrue(connection.isRetryAbortsInternally());
+
+ // It should not be possible to change the value when there is an active transaction.
+ connection.setReadOnly(false);
+ connection.setAutocommit(false);
+ connection.execute(Statement.of(SELECT));
+ assertThrows(SpannerException.class, () -> connection.setRetryAbortsInternally(false));
+ // Verify that the value did not change.
+ assertTrue(connection.isRetryAbortsInternally());
+
+ // Rolling back the connection should allow us to set the property again.
+ connection.rollback();
+ connection.setRetryAbortsInternally(false);
+ assertFalse(connection.isRetryAbortsInternally());
+ }
+ }
+
private void assertThrowResultNotAllowed(
AbstractStatementParser parser, String sql, ImmutableSet allowedResultTypes) {
SpannerException exception =
From 2f6182e6402e279d4b93b1f58cbcfae3124d0034 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Knut=20Olav=20L=C3=B8ite?=
Date: Thu, 29 Feb 2024 19:20:14 +0100
Subject: [PATCH 09/16] chore: fix float32 NaN comparison + deprecate generator
(#2933)
The FLOAT32 type was only added to the com.google.cloud.spanner.RandomResultSetGenerator,
but that generator misses multiple other types. The one in the .connection package
should be used instead. This PR therefore deprecates the one that should not be used,
and updates all tests that used the old one.
It also adds FLOAT32 to the .connection.RandomResultSetGenerator, which is used by
a larger number of tests. This discovered a bug in the FLOAT32 NaN comparison,
which is also fixed in this PR.
Note: The commit is not marked with 'fix:', as the feature has not yet been
released.
---
.../java/com/google/cloud/spanner/Value.java | 4 +++
.../cloud/spanner/AsyncResultSetImplTest.java | 4 +--
.../cloud/spanner/DatabaseClientImplTest.java | 36 +++++++++++++++++++
.../spanner/InlineBeginTransactionTest.java | 1 +
.../spanner/RandomResultSetGenerator.java | 2 ++
.../com/google/cloud/spanner/ValueTest.java | 3 ++
.../connection/AbstractMockServerTest.java | 1 -
.../connection/MergedResultSetTest.java | 2 +-
.../PartitionedQueryMockServerTest.java | 13 ++++---
.../connection/RandomResultSetGenerator.java | 12 +++++++
10 files changed, 70 insertions(+), 8 deletions(-)
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Value.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Value.java
index e4db5ff146..49a6c1e7bc 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Value.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Value.java
@@ -1628,6 +1628,10 @@ void valueToString(StringBuilder b) {
@Override
boolean valueEquals(Value v) {
+ // NaN == NaN always returns false, so we need a custom check.
+ if (Float.isNaN(this.value)) {
+ return Float.isNaN(((Float32Impl) v).value);
+ }
return ((Float32Impl) v).value == value;
}
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/AsyncResultSetImplTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/AsyncResultSetImplTest.java
index 9a6bafa7bf..98497fbf14 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/AsyncResultSetImplTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/AsyncResultSetImplTest.java
@@ -193,9 +193,9 @@ public void withCallback() throws InterruptedException {
});
}
finishedLatch.await();
- // There should be between 1 and 4 callbacks, depending on the timing of the threads.
+ // There should be between 1 and 5 callbacks, depending on the timing of the threads.
// Normally, there should be just 1 callback.
- assertThat(callbackCounter.get()).isIn(Range.closed(1, 4));
+ assertThat(callbackCounter.get()).isIn(Range.closed(1, 5));
assertThat(rowCounter.get()).isEqualTo(3);
}
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/DatabaseClientImplTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/DatabaseClientImplTest.java
index 8dfbb986eb..7cba80edd8 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/DatabaseClientImplTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/DatabaseClientImplTest.java
@@ -4083,6 +4083,7 @@ public void testGetAllTypesAsString() {
int col = 0;
assertAsString("true", resultSet, col++);
assertAsString("100", resultSet, col++);
+ assertAsString("-3.14", resultSet, col++);
assertAsString("3.14", resultSet, col++);
assertAsString("6.626", resultSet, col++);
assertAsString("test-string", resultSet, col++);
@@ -4100,6 +4101,15 @@ public void testGetAllTypesAsString() {
String.format("%d", Long.MAX_VALUE), String.format("%d", Long.MIN_VALUE), "NULL"),
resultSet,
col++);
+ assertAsString(
+ ImmutableList.of(
+ "NULL",
+ Float.valueOf(Float.MAX_VALUE).toString(),
+ Float.valueOf(Float.MIN_VALUE).toString(),
+ "NaN",
+ "3.14"),
+ resultSet,
+ col++);
assertAsString(ImmutableList.of("NULL", "-12345.6789", "3.14"), resultSet, col++);
assertAsString(ImmutableList.of("6.626", "NULL", "-8.9123"), resultSet, col++);
assertAsString(ImmutableList.of("test-string1", "NULL", "test-string2"), resultSet, col++);
@@ -4561,6 +4571,7 @@ private ListValue getRows(Dialect dialect) {
ListValue.newBuilder()
.addValues(com.google.protobuf.Value.newBuilder().setBoolValue(true).build())
.addValues(com.google.protobuf.Value.newBuilder().setStringValue("100").build())
+ .addValues(com.google.protobuf.Value.newBuilder().setNumberValue(-3.14f).build())
.addValues(com.google.protobuf.Value.newBuilder().setNumberValue(3.14d).build())
.addValues(com.google.protobuf.Value.newBuilder().setStringValue("6.626").build())
.addValues(com.google.protobuf.Value.newBuilder().setStringValue("test-string").build())
@@ -4609,6 +4620,31 @@ private ListValue getRows(Dialect dialect) {
.setNullValue(NullValue.NULL_VALUE)
.build())
.build()))
+ .addValues(
+ com.google.protobuf.Value.newBuilder()
+ .setListValue(
+ ListValue.newBuilder()
+ .addValues(
+ com.google.protobuf.Value.newBuilder()
+ .setNullValue(NullValue.NULL_VALUE)
+ .build())
+ .addValues(
+ com.google.protobuf.Value.newBuilder()
+ .setNumberValue(Float.MAX_VALUE)
+ .build())
+ .addValues(
+ com.google.protobuf.Value.newBuilder()
+ .setNumberValue(Float.MIN_VALUE)
+ .build())
+ .addValues(
+ com.google.protobuf.Value.newBuilder()
+ .setStringValue("NaN")
+ .build())
+ .addValues(
+ com.google.protobuf.Value.newBuilder()
+ .setNumberValue(3.14f)
+ .build())
+ .build()))
.addValues(
com.google.protobuf.Value.newBuilder()
.setListValue(
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/InlineBeginTransactionTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/InlineBeginTransactionTest.java
index c7f5e39606..c67c008467 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/InlineBeginTransactionTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/InlineBeginTransactionTest.java
@@ -37,6 +37,7 @@
import com.google.cloud.spanner.MockSpannerServiceImpl.StatementResult;
import com.google.cloud.spanner.TransactionRunner.TransactionCallable;
import com.google.cloud.spanner.TransactionRunnerImpl.TransactionContextImpl;
+import com.google.cloud.spanner.connection.RandomResultSetGenerator;
import com.google.common.collect.ImmutableList;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.protobuf.AbstractMessage;
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/RandomResultSetGenerator.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/RandomResultSetGenerator.java
index 6cf1d0900a..058429d3ba 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/RandomResultSetGenerator.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/RandomResultSetGenerator.java
@@ -31,6 +31,8 @@
import com.google.spanner.v1.TypeCode;
import java.util.Random;
+/** @deprecated Use {@link com.google.cloud.spanner.connection.RandomResultSetGenerator} instead. */
+@Deprecated
public class RandomResultSetGenerator {
private static final Type[] TYPES =
new Type[] {
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ValueTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ValueTest.java
index d692fc44e7..460c646807 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ValueTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ValueTest.java
@@ -193,6 +193,7 @@ public void float32() {
assertThat(v.getFloat32()).isWithin(0.0001f).of(1.23f);
assertThat(v.toString()).isEqualTo("1.23");
assertEquals("1.23", v.getAsString());
+ assertEquals(Value.float32(Float.NaN), Value.float32(Float.NaN));
}
@Test
@@ -224,6 +225,7 @@ public void float64() {
assertThat(v.getFloat64()).isWithin(0.0001).of(1.23);
assertThat(v.toString()).isEqualTo("1.23");
assertEquals("1.23", v.getAsString());
+ assertEquals(Value.float64(Double.NaN), Value.float64(Double.NaN));
}
@Test
@@ -267,6 +269,7 @@ public void pgNumeric() {
assertEquals(1234.5678D, value.getFloat64(), 0.00001);
assertEquals("1234.5678", value.toString());
assertEquals("1234.5678", value.getAsString());
+ assertEquals(Value.pgNumeric("NaN"), Value.pgNumeric("NaN"));
}
@Test
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/AbstractMockServerTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/AbstractMockServerTest.java
index af67859b4a..9af443293a 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/AbstractMockServerTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/AbstractMockServerTest.java
@@ -19,7 +19,6 @@
import com.google.cloud.spanner.ForceCloseSpannerFunction;
import com.google.cloud.spanner.MockSpannerServiceImpl;
import com.google.cloud.spanner.MockSpannerServiceImpl.StatementResult;
-import com.google.cloud.spanner.RandomResultSetGenerator;
import com.google.cloud.spanner.Statement;
import com.google.cloud.spanner.admin.database.v1.MockDatabaseAdminImpl;
import com.google.cloud.spanner.admin.instance.v1.MockInstanceAdminImpl;
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/MergedResultSetTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/MergedResultSetTest.java
index 3cf717e176..8a309115c7 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/MergedResultSetTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/MergedResultSetTest.java
@@ -150,7 +150,7 @@ public void testAllResultsAreReturned() {
if (numPartitions == 0) {
assertEquals(0, resultSet.getColumnCount());
} else {
- assertEquals(22, resultSet.getColumnCount());
+ assertEquals(24, resultSet.getColumnCount());
assertEquals(Type.bool(), resultSet.getColumnType(0));
assertEquals(Type.bool(), resultSet.getColumnType("COL0"));
assertEquals(10, resultSet.getColumnIndex("COL10"));
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/PartitionedQueryMockServerTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/PartitionedQueryMockServerTest.java
index e5731ff0f6..2536b74f10 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/PartitionedQueryMockServerTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/PartitionedQueryMockServerTest.java
@@ -58,15 +58,20 @@ public static Object[] data() {
@Parameter public Dialect dialect;
+ private Dialect currentDialect;
+
@Before
public void setupDialect() {
- mockSpanner.putStatementResult(StatementResult.detectDialectResult(dialect));
+ if (currentDialect != dialect) {
+ mockSpanner.putStatementResult(StatementResult.detectDialectResult(dialect));
+ SpannerPool.closeSpannerPool();
+ currentDialect = dialect;
+ }
}
@After
public void clearRequests() {
mockSpanner.clearRequests();
- SpannerPool.closeSpannerPool();
}
@Test
@@ -349,9 +354,9 @@ public void testRunEmptyPartitionedQuery() {
statement, PartitionOptions.newBuilder().setMaxPartitions(maxPartitions).build())) {
assertFalse(resultSet.next());
assertNotNull(resultSet.getMetadata());
- assertEquals(22, resultSet.getMetadata().getRowType().getFieldsCount());
+ assertEquals(24, resultSet.getMetadata().getRowType().getFieldsCount());
assertNotNull(resultSet.getType());
- assertEquals(22, resultSet.getType().getStructFields().size());
+ assertEquals(24, resultSet.getType().getStructFields().size());
}
}
assertEquals(1, mockSpanner.countRequestsOfType(CreateSessionRequest.class));
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/RandomResultSetGenerator.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/RandomResultSetGenerator.java
index 2067d36b5e..ef38df0db3 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/RandomResultSetGenerator.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/RandomResultSetGenerator.java
@@ -51,6 +51,7 @@ public static Type[] generateAllTypes(Dialect dialect) {
Arrays.asList(
Type.newBuilder().setCode(TypeCode.BOOL).build(),
Type.newBuilder().setCode(TypeCode.INT64).build(),
+ Type.newBuilder().setCode(TypeCode.FLOAT32).build(),
Type.newBuilder().setCode(TypeCode.FLOAT64).build(),
dialect == Dialect.POSTGRESQL
? Type.newBuilder()
@@ -76,6 +77,10 @@ public static Type[] generateAllTypes(Dialect dialect) {
.setCode(TypeCode.ARRAY)
.setArrayElementType(Type.newBuilder().setCode(TypeCode.INT64))
.build(),
+ Type.newBuilder()
+ .setCode(TypeCode.ARRAY)
+ .setArrayElementType(Type.newBuilder().setCode(TypeCode.FLOAT32))
+ .build(),
Type.newBuilder()
.setCode(TypeCode.ARRAY)
.setArrayElementType(Type.newBuilder().setCode(TypeCode.FLOAT64))
@@ -229,6 +234,13 @@ private void setRandomValue(Value.Builder builder, Type type) {
random.nextInt(2019) + 1, random.nextInt(11) + 1, random.nextInt(28) + 1);
builder.setStringValue(date.toString());
break;
+ case FLOAT32:
+ if (randomNaN()) {
+ builder.setNumberValue(Float.NaN);
+ } else {
+ builder.setNumberValue(random.nextFloat());
+ }
+ break;
case FLOAT64:
if (randomNaN()) {
builder.setNumberValue(Double.NaN);
From 9a8cce8aa33903aba3c281d5d8542a581023567a Mon Sep 17 00:00:00 2001
From: Arpan Mishra
Date: Sat, 2 Mar 2024 15:36:18 +0530
Subject: [PATCH 10/16] test: add a default benchmark for measuring baselines.
(#2739)
* Adding a benchmark (along with usual considerations) for measuring the latencies of some Java Client APIs. For any new feature, we usually first define the baseline by running benchmarks (without the feature).
* Adding few utility methods to measure the p99/p95/p50 latencies.
* Added benchmarking best-practices to avoid hotspot (by randomising keys), avoid cold start, etc.
---
.../spanner/AbstractLatencyBenchmark.java | 62 ++++
.../spanner/BenchmarkingUtilityScripts.java | 142 +++++++++
.../cloud/spanner/DefaultBenchmark.java | 270 ++++++++++++++++++
3 files changed, 474 insertions(+)
create mode 100644 google-cloud-spanner/src/test/java/com/google/cloud/spanner/AbstractLatencyBenchmark.java
create mode 100644 google-cloud-spanner/src/test/java/com/google/cloud/spanner/BenchmarkingUtilityScripts.java
create mode 100644 google-cloud-spanner/src/test/java/com/google/cloud/spanner/DefaultBenchmark.java
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/AbstractLatencyBenchmark.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/AbstractLatencyBenchmark.java
new file mode 100644
index 0000000000..d7edf64030
--- /dev/null
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/AbstractLatencyBenchmark.java
@@ -0,0 +1,62 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.cloud.spanner;
+
+import java.time.Duration;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.stream.Collectors;
+
+public abstract class AbstractLatencyBenchmark {
+
+ /** Utility to print latency numbers. It computes metrics such as Average, P50, P95 and P99. */
+ public void printResults(List results) {
+ if (results == null) {
+ return;
+ }
+ List orderedResults = new ArrayList<>(results);
+ Collections.sort(orderedResults);
+ System.out.println();
+ System.out.printf("Total number of queries: %d\n", orderedResults.size());
+ System.out.printf("Avg: %fs\n", avg(results));
+ System.out.printf("P50: %fs\n", percentile(50, orderedResults));
+ System.out.printf("P95: %fs\n", percentile(95, orderedResults));
+ System.out.printf("P99: %fs\n", percentile(99, orderedResults));
+ }
+
+ private double percentile(int percentile, List orderedResults) {
+ int index = percentile * orderedResults.size() / 100;
+ Duration value = orderedResults.get(index);
+ Double convertedValue = convertDurationToFractionInSeconds(value);
+ return convertedValue;
+ }
+
+ /** Returns the average duration in seconds from a list of duration values. */
+ private double avg(List results) {
+ return results.stream()
+ .collect(Collectors.averagingDouble(this::convertDurationToFractionInSeconds));
+ }
+
+ private double convertDurationToFractionInSeconds(Duration duration) {
+ long seconds = duration.getSeconds();
+ long nanos = duration.getNano();
+ double fraction = (double) nanos / 1_000_000_000;
+ double value = seconds + fraction;
+ return value;
+ }
+}
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/BenchmarkingUtilityScripts.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/BenchmarkingUtilityScripts.java
new file mode 100644
index 0000000000..75e0ca3da0
--- /dev/null
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/BenchmarkingUtilityScripts.java
@@ -0,0 +1,142 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.cloud.spanner;
+
+import com.google.api.gax.rpc.ServerStream;
+import com.google.common.collect.ImmutableList;
+import com.google.common.util.concurrent.ListenableFuture;
+import com.google.common.util.concurrent.ListeningScheduledExecutorService;
+import com.google.rpc.Code;
+import com.google.spanner.v1.BatchWriteResponse;
+import java.time.Duration;
+import java.util.ArrayList;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.concurrent.Future;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+/**
+ * Hosts a bunch of utility methods/scripts that can be used while performing benchmarks to load
+ * data, report latency metrics, etc.
+ *
+ * Table schema used here: CREATE TABLE FOO ( id INT64 NOT NULL, BAZ INT64, BAR INT64, ) PRIMARY
+ * KEY(id);
+ */
+@Category(SlowTest.class)
+@RunWith(JUnit4.class)
+public class BenchmarkingUtilityScripts {
+
+ // TODO(developer): Add your values here for PROJECT_ID, INSTANCE_ID, DATABASE_ID
+ // TODO(developer): By default these values are blank and should be replaced before a run.
+ private static final String PROJECT_ID = "";
+ private static final String INSTANCE_ID = "";
+ private static final String DATABASE_ID = "";
+ private static final String SERVER_URL = "https://staging-wrenchworks.sandbox.googleapis.com";
+ private static DatabaseClient client;
+ private static Spanner spanner;
+
+ @BeforeClass
+ public static void beforeClass() {
+ final SpannerOptions.Builder optionsBuilder =
+ SpannerOptions.newBuilder()
+ .setProjectId(PROJECT_ID)
+ .setAutoThrottleAdministrativeRequests();
+ if (!SERVER_URL.isEmpty()) {
+ optionsBuilder.setHost(SERVER_URL);
+ }
+ final SpannerOptions options = optionsBuilder.build();
+ spanner = options.getService();
+ client = spanner.getDatabaseClient(DatabaseId.of(PROJECT_ID, INSTANCE_ID, DATABASE_ID));
+
+ // Delete all existing data from the table
+ client.write(ImmutableList.of(Mutation.delete("FOO", KeySet.all())));
+ }
+
+ @AfterClass
+ public static void afterClass() {
+ spanner.close();
+ }
+
+ /**
+ * A utility which bulk inserts 10^6 records into the database in batches. The method assumes that
+ * the instance/database/table is already created. It does not perform any admin operations.
+ *
+ *
Table schema used here: CREATE TABLE FOO ( id INT64 NOT NULL, BAZ INT64, BAR INT64, )
+ * PRIMARY KEY(id);
+ */
+ @Test
+ public void bulkInsertTestData() {
+ int key = 0;
+ List mutationGroups = new ArrayList<>();
+ for (int batch = 0; batch < 100; batch++) {
+ List mutations = new LinkedList<>();
+ for (int i = 0; i < 10000; i++) {
+ mutations.add(
+ Mutation.newInsertBuilder("FOO")
+ .set("id")
+ .to(key)
+ .set("BAZ")
+ .to(1)
+ .set("BAR")
+ .to(2)
+ .build());
+ key++;
+ }
+ mutationGroups.add(MutationGroup.of(mutations));
+ }
+ ServerStream responses = client.batchWriteAtLeastOnce(mutationGroups);
+ for (BatchWriteResponse response : responses) {
+ if (response.getStatus().getCode() == Code.OK_VALUE) {
+ System.out.printf(
+ "Mutation group indexes %s have been applied with commit timestamp %s",
+ response.getIndexesList(), response.getCommitTimestamp());
+ } else {
+ System.out.printf(
+ "Mutation group indexes %s could not be applied with error code %s and "
+ + "error message %s",
+ response.getIndexesList(),
+ Code.forNumber(response.getStatus().getCode()),
+ response.getStatus().getMessage());
+ }
+ }
+ }
+
+ /** Collects all results from a collection of future objects. */
+ public static List collectResults(
+ final ListeningScheduledExecutorService service,
+ final List>> results,
+ final int numOperations,
+ final Duration timeoutDuration)
+ throws Exception {
+ service.shutdown();
+ if (!service.awaitTermination(timeoutDuration.toMinutes(), TimeUnit.MINUTES)) {
+ throw new TimeoutException();
+ }
+ List allResults = new ArrayList<>(numOperations);
+ for (Future> result : results) {
+ allResults.addAll(result.get());
+ }
+ return allResults;
+ }
+}
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/DefaultBenchmark.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/DefaultBenchmark.java
new file mode 100644
index 0000000000..84578dd323
--- /dev/null
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/DefaultBenchmark.java
@@ -0,0 +1,270 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.cloud.spanner;
+
+import static com.google.cloud.spanner.BenchmarkingUtilityScripts.collectResults;
+import static com.google.common.truth.Truth.assertThat;
+
+import com.google.common.base.Stopwatch;
+import com.google.common.util.concurrent.ListenableFuture;
+import com.google.common.util.concurrent.ListeningScheduledExecutorService;
+import com.google.common.util.concurrent.MoreExecutors;
+import java.time.Duration;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.Executors;
+import java.util.concurrent.ThreadLocalRandom;
+import java.util.concurrent.TimeUnit;
+import org.openjdk.jmh.annotations.AuxCounters;
+import org.openjdk.jmh.annotations.Benchmark;
+import org.openjdk.jmh.annotations.BenchmarkMode;
+import org.openjdk.jmh.annotations.Fork;
+import org.openjdk.jmh.annotations.Level;
+import org.openjdk.jmh.annotations.Measurement;
+import org.openjdk.jmh.annotations.Mode;
+import org.openjdk.jmh.annotations.OutputTimeUnit;
+import org.openjdk.jmh.annotations.Scope;
+import org.openjdk.jmh.annotations.Setup;
+import org.openjdk.jmh.annotations.State;
+import org.openjdk.jmh.annotations.TearDown;
+import org.openjdk.jmh.annotations.Warmup;
+
+/**
+ * Benchmarks for measuring existing latencies of various APIs using the Java Client. The benchmarks
+ * are bound to the Maven profile `benchmark` and can be executed like this: mvn clean test
+ * -DskipTests -Pbenchmark -Dbenchmark.name=DefaultBenchmark
+ * Test Table Schema :
+ *
+ * CREATE TABLE FOO ( id INT64 NOT NULL, BAZ INT64, BAR INT64, ) PRIMARY KEY(id);
+ *
+ *
Below are a few considerations here: 1. We use all default options for this test because that
+ * is what most customers would be using. 2. The test schema uses a numeric primary key. To ensure
+ * that the reads/updates are distributed across a large query space, we insert 10^5 records.
+ * Utility at {@link BenchmarkingUtilityScripts} can be used for loading data. 3. For queries, we
+ * make sure that the query is sampled randomly across a large query space. This ensure we don't
+ * cause hot-spots. 4. For avoid cold start issues, we execute 1 query/update and ignore its latency
+ * from the final reported metrics.
+ */
+@BenchmarkMode(Mode.AverageTime)
+@Fork(value = 1, warmups = 0)
+@Measurement(batchSize = 1, iterations = 1, timeUnit = TimeUnit.MILLISECONDS)
+@OutputTimeUnit(TimeUnit.SECONDS)
+@Warmup(iterations = 1)
+public class DefaultBenchmark extends AbstractLatencyBenchmark {
+
+ private static final String SELECT_QUERY = "SELECT ID FROM FOO WHERE ID = @id";
+ private static final String UPDATE_QUERY = "UPDATE FOO SET BAR=1 WHERE ID = @id";
+ private static final String ID_COLUMN_NAME = "id";
+
+ /**
+ * Used to determine how many concurrent requests are allowed. For ex - To simulate a low QPS
+ * scenario, using 1 thread means there will be 1 request. Use a value > 1 to have concurrent
+ * requests.
+ */
+ private static final int PARALLEL_THREADS = 1;
+
+ /**
+ * Total number of reads per test run for 1 thread. Increasing the value here will increase the
+ * duration of the benchmark. For ex - With PARALLEL_THREADS = 2, TOTAL_READS_PER_RUN = 200, there
+ * will be 400 read requests (200 on each thread).
+ */
+ private static final int TOTAL_READS_PER_RUN = 12000;
+
+ /**
+ * Total number of writes per test run for 1 thread. Increasing the value here will increase the
+ * duration of the benchmark. For ex - With PARALLEL_THREADS = 2, TOTAL_WRITES_PER_RUN = 200,
+ * there will be 400 write requests (200 on each thread).
+ */
+ private static final int TOTAL_WRITES_PER_RUN = 4000;
+
+ /**
+ * Number of requests which are used to initialise/warmup the benchmark. The latency number of
+ * these runs are ignored from the final reported results.
+ */
+ private static final int WARMUP_REQUEST_COUNT = 1;
+
+ /**
+ * Numbers of records in the sample table used in the benchmark. This is used in this benchmark to
+ * randomly choose a primary key and ensure that the reads are randomly distributed. This is done
+ * to ensure we don't end up reading/writing the same table record (leading to hot-spotting).
+ */
+ private static final int TOTAL_RECORDS = 1000000;
+
+ @State(Scope.Thread)
+ @AuxCounters(org.openjdk.jmh.annotations.AuxCounters.Type.EVENTS)
+ public static class BenchmarkState {
+
+ // TODO(developer): Add your values here for PROJECT_ID, INSTANCE_ID, DATABASE_ID
+ private static final String INSTANCE_ID = "";
+ private static final String DATABASE_ID = "";
+ private static final String SERVER_URL = "https://staging-wrenchworks.sandbox.googleapis.com";
+ private Spanner spanner;
+ private DatabaseClientImpl client;
+
+ @Setup(Level.Iteration)
+ public void setup() throws Exception {
+ SpannerOptions options =
+ SpannerOptions.newBuilder()
+ .setSessionPoolOption(
+ SessionPoolOptions.newBuilder()
+ .setWaitForMinSessions(org.threeten.bp.Duration.ofSeconds(20))
+ .build())
+ .setHost(SERVER_URL)
+ .build();
+ spanner = options.getService();
+ client =
+ (DatabaseClientImpl)
+ spanner.getDatabaseClient(
+ DatabaseId.of(options.getProjectId(), INSTANCE_ID, DATABASE_ID));
+ }
+
+ @TearDown(Level.Iteration)
+ public void teardown() throws Exception {
+ spanner.close();
+ }
+ }
+
+ /** Measures the time needed to execute a burst of queries. */
+ @Benchmark
+ public void burstQueries(final BenchmarkState server) throws Exception {
+ final DatabaseClientImpl client = server.client;
+ SessionPool pool = client.pool;
+ assertThat(pool.totalSessions())
+ .isEqualTo(server.spanner.getOptions().getSessionPoolOptions().getMinSessions());
+
+ ListeningScheduledExecutorService service =
+ MoreExecutors.listeningDecorator(Executors.newScheduledThreadPool(PARALLEL_THREADS));
+ List>> results = new ArrayList<>(PARALLEL_THREADS);
+ for (int i = 0; i < PARALLEL_THREADS; i++) {
+ results.add(service.submit(() -> runBenchmarksForQueries(server, TOTAL_READS_PER_RUN)));
+ }
+ collectResultsAndPrint(service, results, TOTAL_READS_PER_RUN);
+ }
+
+ /** Measures the time needed to execute a burst of read and write requests. */
+ @Benchmark
+ public void burstQueriesAndWrites(final BenchmarkState server) throws Exception {
+ final DatabaseClientImpl client = server.client;
+ SessionPool pool = client.pool;
+ assertThat(pool.totalSessions())
+ .isEqualTo(server.spanner.getOptions().getSessionPoolOptions().getMinSessions());
+
+ ListeningScheduledExecutorService service =
+ MoreExecutors.listeningDecorator(Executors.newScheduledThreadPool(PARALLEL_THREADS));
+ List>> results = new ArrayList<>(PARALLEL_THREADS);
+ for (int i = 0; i < PARALLEL_THREADS; i++) {
+ results.add(service.submit(() -> runBenchmarksForQueries(server, TOTAL_READS_PER_RUN)));
+ }
+ for (int i = 0; i < PARALLEL_THREADS; i++) {
+ results.add(service.submit(() -> runBenchmarkForUpdates(server, TOTAL_WRITES_PER_RUN)));
+ }
+
+ collectResultsAndPrint(service, results, TOTAL_READS_PER_RUN + TOTAL_WRITES_PER_RUN);
+ }
+
+ /** Measures the time needed to execute a burst of read and write requests. */
+ @Benchmark
+ public void burstUpdates(final BenchmarkState server) throws Exception {
+ final DatabaseClientImpl client = server.client;
+ SessionPool pool = client.pool;
+ assertThat(pool.totalSessions())
+ .isEqualTo(server.spanner.getOptions().getSessionPoolOptions().getMinSessions());
+
+ ListeningScheduledExecutorService service =
+ MoreExecutors.listeningDecorator(Executors.newScheduledThreadPool(PARALLEL_THREADS));
+ List>> results = new ArrayList<>(PARALLEL_THREADS);
+ for (int i = 0; i < PARALLEL_THREADS; i++) {
+ results.add(service.submit(() -> runBenchmarkForUpdates(server, TOTAL_WRITES_PER_RUN)));
+ }
+
+ collectResultsAndPrint(service, results, TOTAL_WRITES_PER_RUN);
+ }
+
+ private List runBenchmarksForQueries(
+ final BenchmarkState server, int numberOfOperations) {
+ List results = new ArrayList<>(numberOfOperations);
+ // Execute one query to make sure everything has been warmed up.
+ executeWarmup(server);
+
+ for (int i = 0; i < numberOfOperations; i++) {
+ results.add(executeQuery(server));
+ }
+ return results;
+ }
+
+ private void executeWarmup(final BenchmarkState server) {
+ for (int i = 0; i < WARMUP_REQUEST_COUNT; i++) {
+ executeQuery(server);
+ }
+ }
+
+ private java.time.Duration executeQuery(final BenchmarkState server) {
+ Stopwatch watch = Stopwatch.createStarted();
+
+ try (ResultSet rs = server.client.singleUse().executeQuery(getRandomisedReadStatement())) {
+ while (rs.next()) {
+ int count = rs.getColumnCount();
+ }
+ }
+ return watch.elapsed();
+ }
+
+ private List runBenchmarkForUpdates(
+ final BenchmarkState server, int numberOfOperations) {
+ List results = new ArrayList<>(numberOfOperations);
+ // Execute one query to make sure everything has been warmed up.
+ executeWarmup(server);
+
+ // Execute one update to make sure everything has been warmed up.
+ executeUpdate(server);
+
+ for (int i = 0; i < numberOfOperations; i++) {
+ results.add(executeUpdate(server));
+ }
+ return results;
+ }
+
+ private Duration executeUpdate(final BenchmarkState server) {
+ Stopwatch watch = Stopwatch.createStarted();
+
+ TransactionRunner runner = server.client.readWriteTransaction();
+ runner.run(transaction -> transaction.executeUpdate(getRandomisedUpdateStatement()));
+
+ return watch.elapsed();
+ }
+
+ static Statement getRandomisedReadStatement() {
+ int randomKey = ThreadLocalRandom.current().nextInt(TOTAL_RECORDS);
+ return Statement.newBuilder(SELECT_QUERY).bind(ID_COLUMN_NAME).to(randomKey).build();
+ }
+
+ static Statement getRandomisedUpdateStatement() {
+ int randomKey = ThreadLocalRandom.current().nextInt(TOTAL_RECORDS);
+ return Statement.newBuilder(UPDATE_QUERY).bind(ID_COLUMN_NAME).to(randomKey).build();
+ }
+
+ void collectResultsAndPrint(
+ ListeningScheduledExecutorService service,
+ List>> results,
+ int numOperationsPerThread)
+ throws Exception {
+ final List collectResults =
+ collectResults(
+ service, results, numOperationsPerThread * PARALLEL_THREADS, Duration.ofMinutes(60));
+ printResults(collectResults);
+ }
+}
From ccb110ad6835557870933c95cfd76580fd317a16 Mon Sep 17 00:00:00 2001
From: Arpan Mishra
Date: Mon, 4 Mar 2024 12:24:07 +0530
Subject: [PATCH 11/16] docs: update all public documents to use auto-generated
admin clients. (#2928)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
* fix: prevent illegal negative timeout values into thread sleep() method while retrying exceptions in unit tests.
* For details on issue see - https://github.com/googleapis/java-spanner/issues/2206
* Fixing lint issues.
* docs: update all public documents to use auto-generated admin clients.
* chore: fix lint issue.
* 🦉 Updates from OwlBot post-processor
See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md
---------
Co-authored-by: Owl Bot
---
README.md | 75 +-
samples/README.md | 2 +-
samples/snippets/pom.xml | 2 +-
.../spanner/AddAndDropDatabaseRole.java | 82 +--
.../example/spanner/AddJsonColumnSample.java | 37 +-
.../example/spanner/AddJsonbColumnSample.java | 38 +-
.../spanner/AddNumericColumnSample.java | 38 +-
.../example/spanner/AlterSequenceSample.java | 18 +-
...ableWithForeignKeyDeleteCascadeSample.java | 44 +-
.../com/example/spanner/CopyBackupSample.java | 82 +--
.../CreateBackupWithEncryptionKey.java | 65 +-
...CreateDatabaseWithDefaultLeaderSample.java | 85 +--
.../CreateDatabaseWithEncryptionKey.java | 60 +-
...abaseWithVersionRetentionPeriodSample.java | 56 +-
.../spanner/CreateInstanceConfigSample.java | 76 +-
.../spanner/CreateInstanceExample.java | 56 +-
...eInstanceWithAutoscalingConfigExample.java | 97 +--
...ateInstanceWithProcessingUnitsExample.java | 78 +-
.../example/spanner/CreateSequenceSample.java | 21 +-
...ableWithForeignKeyDeleteCascadeSample.java | 56 +-
.../spanner/DeleteInstanceConfigSample.java | 28 +-
...reignKeyConstraintDeleteCascadeSample.java | 40 +-
.../example/spanner/DropSequenceSample.java | 20 +-
.../spanner/EnableFineGrainedAccess.java | 50 +-
.../example/spanner/GetDatabaseDdlSample.java | 19 +-
.../spanner/GetInstanceConfigSample.java | 35 +-
.../example/spanner/ListDatabaseRoles.java | 29 +-
.../example/spanner/ListDatabasesSample.java | 27 +-
.../ListInstanceConfigOperationsSample.java | 61 +-
.../spanner/ListInstanceConfigsSample.java | 30 +-
.../spanner/PgAlterSequenceSample.java | 20 +-
.../spanner/PgCaseSensitivitySample.java | 42 +-
.../spanner/PgCreateSequenceSample.java | 21 +-
.../example/spanner/PgDropSequenceSample.java | 20 +-
.../spanner/PgInterleavedTableSample.java | 45 +-
.../com/example/spanner/PgSpannerSample.java | 490 +++++++------
.../RestoreBackupWithEncryptionKey.java | 45 +-
.../com/example/spanner/SpannerSample.java | 660 +++++++++--------
.../example/spanner/UpdateDatabaseSample.java | 40 +-
...UpdateDatabaseWithDefaultLeaderSample.java | 27 +-
.../spanner/UpdateInstanceConfigSample.java | 59 +-
.../example/spanner/admin/archived/.gitkeep | 0
.../archived/AddAndDropDatabaseRole.java | 88 +++
.../AddJsonColumnSample.java | 39 +-
.../AddJsonbColumnSample.java | 40 +-
.../AddNumericColumnSample.java | 40 +-
.../AlterSequenceSample.java | 20 +-
...ableWithForeignKeyDeleteCascadeSample.java | 46 +-
.../admin/archived/CopyBackupSample.java | 101 +++
.../CreateBackupWithEncryptionKey.java | 67 +-
...CreateDatabaseWithDefaultLeaderSample.java | 85 +++
.../CreateDatabaseWithEncryptionKey.java | 62 +-
...abaseWithVersionRetentionPeriodSample.java | 58 +-
.../archived/CreateInstanceConfigSample.java | 74 ++
.../CreateInstanceExample.java | 58 +-
...eInstanceWithAutoscalingConfigExample.java | 84 +++
...ateInstanceWithProcessingUnitsExample.java | 76 ++
.../CreateSequenceSample.java | 23 +-
...ableWithForeignKeyDeleteCascadeSample.java | 66 ++
.../DeleteInstanceConfigSample.java | 30 +-
...reignKeyConstraintDeleteCascadeSample.java | 42 +-
.../DropSequenceSample.java | 22 +-
.../EnableFineGrainedAccess.java | 52 +-
.../GetDatabaseDdlSample.java | 21 +-
.../GetInstanceConfigSample.java | 37 +-
.../ListDatabaseRoles.java | 31 +-
.../ListDatabasesSample.java | 29 +-
.../ListInstanceConfigOperationsSample.java | 66 ++
.../ListInstanceConfigsSample.java | 32 +-
.../PgAlterSequenceSample.java | 22 +-
.../PgCaseSensitivitySample.java | 44 +-
.../PgCreateSequenceSample.java | 23 +-
.../PgDropSequenceSample.java | 22 +-
.../PgInterleavedTableSample.java | 47 +-
.../PgSpannerSample.java | 492 ++++++-------
.../RestoreBackupWithEncryptionKey.java | 47 +-
.../SpannerSample.java | 662 ++++++++---------
.../UpdateDatabaseSample.java | 42 +-
...UpdateDatabaseWithDefaultLeaderSample.java | 29 +-
.../UpdateInstanceConfigSample.java | 61 +-
.../generated/AddAndDropDatabaseRole.java | 80 --
.../admin/generated/CopyBackupSample.java | 97 ---
.../generated/CreateInstanceConfigSample.java | 94 ---
...eInstanceWithAutoscalingConfigExample.java | 93 ---
...ateInstanceWithProcessingUnitsExample.java | 80 --
...ableWithForeignKeyDeleteCascadeSample.java | 66 --
.../ListInstanceConfigOperationsSample.java | 73 --
...leWithForeignKeyDeleteCascadeSampleIT.java | 20 +-
.../{admin/generated => }/CopyBackupIT.java | 3 +-
...eateDatabaseWithDefaultLeaderSampleIT.java | 29 +-
...aseWithVersionRetentionPeriodSampleIT.java | 7 +-
...InstanceWithAutoscalingConfigSampleIT.java | 20 +-
...teInstanceWithProcessingUnitsSampleIT.java | 3 +-
...leWithForeignKeyDeleteCascadeSampleIT.java | 16 +-
.../spanner/CustomInstanceConfigSampleIT.java | 36 +-
.../com/example/spanner/DatabaseRolesIT.java | 29 +-
...ignKeyConstraintDeleteCascadeSampleIT.java | 22 +-
.../com/example/spanner/EncryptionKeyIT.java | 24 +-
.../spanner/GetDatabaseDdlSampleIT.java | 48 +-
.../generated => }/ListDatabasesIT.java | 3 +-
.../spanner/PgCaseSensitivitySampleIT.java | 22 +-
.../spanner/PgInterleavedTableSampleIT.java | 22 +-
.../example/spanner/PgSpannerSampleIT.java | 61 +-
.../PgSpannerStandaloneExamplesIT.java | 7 +-
.../generated => }/SampleTestBaseV2.java | 2 +-
.../com/example/spanner/SequenceSampleIT.java | 52 +-
.../com/example/spanner/SpannerSampleIT.java | 489 +++++++-----
.../spanner/SpannerStandaloneExamplesIT.java | 15 +-
.../spanner/UpdateDatabaseSampleIT.java | 37 +-
...dateDatabaseWithDefaultLeaderSampleIT.java | 35 +-
...leWithForeignKeyDeleteCascadeSampleIT.java | 23 +-
...eateDatabaseWithDefaultLeaderSampleIT.java | 61 ++
...aseWithVersionRetentionPeriodSampleIT.java | 9 +-
...InstanceWithAutoscalingConfigSampleIT.java | 23 +-
...leWithForeignKeyDeleteCascadeSampleIT.java | 17 +-
.../CustomInstanceConfigSampleIT.java | 39 +-
.../DatabaseRolesIT.java | 32 +-
...ignKeyConstraintDeleteCascadeSampleIT.java | 23 +-
.../EncryptionKeyIT.java | 26 +-
.../GetDatabaseDdlSampleIT.java | 51 +-
.../archived}/GetInstanceConfigSampleIT.java | 4 +-
.../ListInstanceConfigsSampleIT.java | 4 +-
.../PgCaseSensitivitySampleIT.java | 25 +-
.../PgInterleavedTableSampleIT.java | 25 +-
.../PgSpannerSampleIT.java | 63 +-
.../SequenceSampleIT.java | 55 +-
.../admin/archived/SpannerSampleIT.java | 593 +++++++++++++++
.../UpdateDatabaseSampleIT.java | 41 +-
...dateDatabaseWithDefaultLeaderSampleIT.java | 39 +-
.../admin/generated/SpannerSampleIT.java | 694 ------------------
130 files changed, 4674 insertions(+), 4514 deletions(-)
delete mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/archived/.gitkeep
create mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/archived/AddAndDropDatabaseRole.java
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/AddJsonColumnSample.java (55%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/AddJsonbColumnSample.java (56%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/AddNumericColumnSample.java (55%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/AlterSequenceSample.java (89%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/AlterTableWithForeignKeyDeleteCascadeSample.java (54%)
create mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/archived/CopyBackupSample.java
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/CreateBackupWithEncryptionKey.java (58%)
create mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateDatabaseWithDefaultLeaderSample.java
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/CreateDatabaseWithEncryptionKey.java (60%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/CreateDatabaseWithVersionRetentionPeriodSample.java (55%)
create mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateInstanceConfigSample.java
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/CreateInstanceExample.java (56%)
create mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateInstanceWithAutoscalingConfigExample.java
create mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateInstanceWithProcessingUnitsExample.java
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/CreateSequenceSample.java (89%)
create mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateTableWithForeignKeyDeleteCascadeSample.java
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/DeleteInstanceConfigSample.java (60%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/DropForeignKeyConstraintDeleteCascadeSample.java (58%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/DropSequenceSample.java (84%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/EnableFineGrainedAccess.java (63%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/GetDatabaseDdlSample.java (67%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/GetInstanceConfigSample.java (54%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/ListDatabaseRoles.java (54%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/ListDatabasesSample.java (61%)
create mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/archived/ListInstanceConfigOperationsSample.java
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/ListInstanceConfigsSample.java (57%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/PgAlterSequenceSample.java (89%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/PgCaseSensitivitySample.java (79%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/PgCreateSequenceSample.java (88%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/PgDropSequenceSample.java (84%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/PgInterleavedTableSample.java (62%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/PgSpannerSample.java (80%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/RestoreBackupWithEncryptionKey.java (65%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/SpannerSample.java (79%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/UpdateDatabaseSample.java (62%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/UpdateDatabaseWithDefaultLeaderSample.java (76%)
rename samples/snippets/src/main/java/com/example/spanner/admin/{generated => archived}/UpdateInstanceConfigSample.java (52%)
delete mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/generated/AddAndDropDatabaseRole.java
delete mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/generated/CopyBackupSample.java
delete mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateInstanceConfigSample.java
delete mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateInstanceWithAutoscalingConfigExample.java
delete mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateInstanceWithProcessingUnitsExample.java
delete mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateTableWithForeignKeyDeleteCascadeSample.java
delete mode 100644 samples/snippets/src/main/java/com/example/spanner/admin/generated/ListInstanceConfigOperationsSample.java
rename samples/snippets/src/test/java/com/example/spanner/{admin/generated => }/CopyBackupIT.java (98%)
rename samples/snippets/src/test/java/com/example/spanner/{admin/generated => }/CreateInstanceWithProcessingUnitsSampleIT.java (93%)
rename samples/snippets/src/test/java/com/example/spanner/{admin/generated => }/ListDatabasesIT.java (92%)
rename samples/snippets/src/test/java/com/example/spanner/{admin/generated => }/SampleTestBaseV2.java (99%)
rename samples/snippets/src/test/java/com/example/spanner/admin/{generated => archived}/AlterTableWithForeignKeyDeleteCascadeSampleIT.java (77%)
create mode 100644 samples/snippets/src/test/java/com/example/spanner/admin/archived/CreateDatabaseWithDefaultLeaderSampleIT.java
rename samples/snippets/src/test/java/com/example/spanner/admin/{generated => archived}/CreateDatabaseWithVersionRetentionPeriodSampleIT.java (84%)
rename samples/snippets/src/test/java/com/example/spanner/admin/{generated => archived}/CreateInstanceWithAutoscalingConfigSampleIT.java (58%)
rename samples/snippets/src/test/java/com/example/spanner/admin/{generated => archived}/CreateTableWithForeignKeyDeleteCascadeSampleIT.java (71%)
rename samples/snippets/src/test/java/com/example/spanner/admin/{generated => archived}/CustomInstanceConfigSampleIT.java (64%)
rename samples/snippets/src/test/java/com/example/spanner/admin/{generated => archived}/DatabaseRolesIT.java (82%)
rename samples/snippets/src/test/java/com/example/spanner/admin/{generated => archived}/DropForeignKeyConstraintDeleteCascadeSampleIT.java (77%)
rename samples/snippets/src/test/java/com/example/spanner/admin/{generated => archived}/EncryptionKeyIT.java (85%)
rename samples/snippets/src/test/java/com/example/spanner/admin/{generated => archived}/GetDatabaseDdlSampleIT.java (56%)
rename samples/snippets/src/test/java/com/example/spanner/{ => admin/archived}/GetInstanceConfigSampleIT.java (90%)
rename samples/snippets/src/test/java/com/example/spanner/{ => admin/archived}/ListInstanceConfigsSampleIT.java (89%)
rename samples/snippets/src/test/java/com/example/spanner/admin/{generated => archived}/PgCaseSensitivitySampleIT.java (62%)
rename samples/snippets/src/test/java/com/example/spanner/admin/{generated => archived}/PgInterleavedTableSampleIT.java (61%)
rename samples/snippets/src/test/java/com/example/spanner/admin/{generated => archived}/PgSpannerSampleIT.java (84%)
rename samples/snippets/src/test/java/com/example/spanner/admin/{generated => archived}/SequenceSampleIT.java (69%)
create mode 100644 samples/snippets/src/test/java/com/example/spanner/admin/archived/SpannerSampleIT.java
rename samples/snippets/src/test/java/com/example/spanner/admin/{generated => archived}/UpdateDatabaseSampleIT.java (53%)
rename samples/snippets/src/test/java/com/example/spanner/admin/{generated => archived}/UpdateDatabaseWithDefaultLeaderSampleIT.java (61%)
delete mode 100644 samples/snippets/src/test/java/com/example/spanner/admin/generated/SpannerSampleIT.java
diff --git a/README.md b/README.md
index 2ed6ff04b4..2172a1582f 100644
--- a/README.md
+++ b/README.md
@@ -509,43 +509,44 @@ Samples are in the [`samples/`](https://github.com/googleapis/java-spanner/tree/
| Update Jsonb Data Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/UpdateJsonbDataSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/UpdateJsonbDataSample.java) |
| Update Numeric Data Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/UpdateNumericDataSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/UpdateNumericDataSample.java) |
| Update Using Dml Returning Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/UpdateUsingDmlReturningSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/UpdateUsingDmlReturningSample.java) |
-| Add And Drop Database Role | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/AddAndDropDatabaseRole.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/AddAndDropDatabaseRole.java) |
-| Add Json Column Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/AddJsonColumnSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/AddJsonColumnSample.java) |
-| Add Jsonb Column Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/AddJsonbColumnSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/AddJsonbColumnSample.java) |
-| Add Numeric Column Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/AddNumericColumnSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/AddNumericColumnSample.java) |
-| Alter Sequence Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/AlterSequenceSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/AlterSequenceSample.java) |
-| Alter Table With Foreign Key Delete Cascade Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/AlterTableWithForeignKeyDeleteCascadeSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/AlterTableWithForeignKeyDeleteCascadeSample.java) |
-| Copy Backup Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/CopyBackupSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/CopyBackupSample.java) |
-| Create Backup With Encryption Key | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateBackupWithEncryptionKey.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateBackupWithEncryptionKey.java) |
-| Create Database With Encryption Key | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateDatabaseWithEncryptionKey.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateDatabaseWithEncryptionKey.java) |
-| Create Database With Version Retention Period Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateDatabaseWithVersionRetentionPeriodSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateDatabaseWithVersionRetentionPeriodSample.java) |
-| Create Instance Config Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateInstanceConfigSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateInstanceConfigSample.java) |
-| Create Instance Example | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateInstanceExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateInstanceExample.java) |
-| Create Instance With Autoscaling Config Example | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateInstanceWithAutoscalingConfigExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateInstanceWithAutoscalingConfigExample.java) |
-| Create Instance With Processing Units Example | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateInstanceWithProcessingUnitsExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateInstanceWithProcessingUnitsExample.java) |
-| Create Sequence Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateSequenceSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateSequenceSample.java) |
-| Create Table With Foreign Key Delete Cascade Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateTableWithForeignKeyDeleteCascadeSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/CreateTableWithForeignKeyDeleteCascadeSample.java) |
-| Delete Instance Config Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/DeleteInstanceConfigSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/DeleteInstanceConfigSample.java) |
-| Drop Foreign Key Constraint Delete Cascade Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/DropForeignKeyConstraintDeleteCascadeSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/DropForeignKeyConstraintDeleteCascadeSample.java) |
-| Drop Sequence Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/DropSequenceSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/DropSequenceSample.java) |
-| Enable Fine Grained Access | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/EnableFineGrainedAccess.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/EnableFineGrainedAccess.java) |
-| Get Database Ddl Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/GetDatabaseDdlSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/GetDatabaseDdlSample.java) |
-| Get Instance Config Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/GetInstanceConfigSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/GetInstanceConfigSample.java) |
-| List Database Roles | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/ListDatabaseRoles.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/ListDatabaseRoles.java) |
-| List Databases Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/ListDatabasesSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/ListDatabasesSample.java) |
-| List Instance Config Operations Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/ListInstanceConfigOperationsSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/ListInstanceConfigOperationsSample.java) |
-| List Instance Configs Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/ListInstanceConfigsSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/ListInstanceConfigsSample.java) |
-| Pg Alter Sequence Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/PgAlterSequenceSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/PgAlterSequenceSample.java) |
-| Pg Case Sensitivity Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/PgCaseSensitivitySample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/PgCaseSensitivitySample.java) |
-| Pg Create Sequence Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/PgCreateSequenceSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/PgCreateSequenceSample.java) |
-| Pg Drop Sequence Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/PgDropSequenceSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/PgDropSequenceSample.java) |
-| Pg Interleaved Table Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/PgInterleavedTableSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/PgInterleavedTableSample.java) |
-| Pg Spanner Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/PgSpannerSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/PgSpannerSample.java) |
-| Restore Backup With Encryption Key | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/RestoreBackupWithEncryptionKey.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/RestoreBackupWithEncryptionKey.java) |
-| Spanner Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/SpannerSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/SpannerSample.java) |
-| Update Database Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/UpdateDatabaseSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/UpdateDatabaseSample.java) |
-| Update Database With Default Leader Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/UpdateDatabaseWithDefaultLeaderSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/UpdateDatabaseWithDefaultLeaderSample.java) |
-| Update Instance Config Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/generated/UpdateInstanceConfigSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/generated/UpdateInstanceConfigSample.java) |
+| Add And Drop Database Role | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/AddAndDropDatabaseRole.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/AddAndDropDatabaseRole.java) |
+| Add Json Column Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/AddJsonColumnSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/AddJsonColumnSample.java) |
+| Add Jsonb Column Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/AddJsonbColumnSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/AddJsonbColumnSample.java) |
+| Add Numeric Column Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/AddNumericColumnSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/AddNumericColumnSample.java) |
+| Alter Sequence Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/AlterSequenceSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/AlterSequenceSample.java) |
+| Alter Table With Foreign Key Delete Cascade Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/AlterTableWithForeignKeyDeleteCascadeSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/AlterTableWithForeignKeyDeleteCascadeSample.java) |
+| Copy Backup Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/CopyBackupSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/CopyBackupSample.java) |
+| Create Backup With Encryption Key | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateBackupWithEncryptionKey.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateBackupWithEncryptionKey.java) |
+| Create Database With Default Leader Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateDatabaseWithDefaultLeaderSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateDatabaseWithDefaultLeaderSample.java) |
+| Create Database With Encryption Key | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateDatabaseWithEncryptionKey.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateDatabaseWithEncryptionKey.java) |
+| Create Database With Version Retention Period Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateDatabaseWithVersionRetentionPeriodSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateDatabaseWithVersionRetentionPeriodSample.java) |
+| Create Instance Config Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateInstanceConfigSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateInstanceConfigSample.java) |
+| Create Instance Example | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateInstanceExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateInstanceExample.java) |
+| Create Instance With Autoscaling Config Example | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateInstanceWithAutoscalingConfigExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateInstanceWithAutoscalingConfigExample.java) |
+| Create Instance With Processing Units Example | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateInstanceWithProcessingUnitsExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateInstanceWithProcessingUnitsExample.java) |
+| Create Sequence Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateSequenceSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateSequenceSample.java) |
+| Create Table With Foreign Key Delete Cascade Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateTableWithForeignKeyDeleteCascadeSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/CreateTableWithForeignKeyDeleteCascadeSample.java) |
+| Delete Instance Config Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/DeleteInstanceConfigSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/DeleteInstanceConfigSample.java) |
+| Drop Foreign Key Constraint Delete Cascade Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/DropForeignKeyConstraintDeleteCascadeSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/DropForeignKeyConstraintDeleteCascadeSample.java) |
+| Drop Sequence Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/DropSequenceSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/DropSequenceSample.java) |
+| Enable Fine Grained Access | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/EnableFineGrainedAccess.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/EnableFineGrainedAccess.java) |
+| Get Database Ddl Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/GetDatabaseDdlSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/GetDatabaseDdlSample.java) |
+| Get Instance Config Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/GetInstanceConfigSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/GetInstanceConfigSample.java) |
+| List Database Roles | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/ListDatabaseRoles.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/ListDatabaseRoles.java) |
+| List Databases Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/ListDatabasesSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/ListDatabasesSample.java) |
+| List Instance Config Operations Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/ListInstanceConfigOperationsSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/ListInstanceConfigOperationsSample.java) |
+| List Instance Configs Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/ListInstanceConfigsSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/ListInstanceConfigsSample.java) |
+| Pg Alter Sequence Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/PgAlterSequenceSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/PgAlterSequenceSample.java) |
+| Pg Case Sensitivity Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/PgCaseSensitivitySample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/PgCaseSensitivitySample.java) |
+| Pg Create Sequence Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/PgCreateSequenceSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/PgCreateSequenceSample.java) |
+| Pg Drop Sequence Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/PgDropSequenceSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/PgDropSequenceSample.java) |
+| Pg Interleaved Table Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/PgInterleavedTableSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/PgInterleavedTableSample.java) |
+| Pg Spanner Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/PgSpannerSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/PgSpannerSample.java) |
+| Restore Backup With Encryption Key | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/RestoreBackupWithEncryptionKey.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/RestoreBackupWithEncryptionKey.java) |
+| Spanner Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/SpannerSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/SpannerSample.java) |
+| Update Database Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/UpdateDatabaseSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/UpdateDatabaseSample.java) |
+| Update Database With Default Leader Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/UpdateDatabaseWithDefaultLeaderSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/UpdateDatabaseWithDefaultLeaderSample.java) |
+| Update Instance Config Sample | [source code](https://github.com/googleapis/java-spanner/blob/main/samples/snippets/src/main/java/com/example/spanner/admin/archived/UpdateInstanceConfigSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-spanner&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/spanner/admin/archived/UpdateInstanceConfigSample.java) |
diff --git a/samples/README.md b/samples/README.md
index 9f961354d9..914c455b46 100644
--- a/samples/README.md
+++ b/samples/README.md
@@ -34,7 +34,7 @@ You can run a given `ClassName` via:
## Tutorial
### Running the tutorial
- mvn exec:java -Dexec.mainClass=com.example.spanner.SpannerSample -Dexec.args=" my-instance my-database"
+ mvn exec:java -Dexec.mainClass=com.example.spanner.admin.archived.SpannerSample -Dexec.args=" my-instance my-database"
## Tracing sample
`TracingSample.java` demonstrates how to export traces generated by client library to StackDriver and to /tracez page.
diff --git a/samples/snippets/pom.xml b/samples/snippets/pom.xml
index e8d2155b33..4103b4ad8e 100644
--- a/samples/snippets/pom.xml
+++ b/samples/snippets/pom.xml
@@ -165,7 +165,7 @@
false
- com.example.spanner.SpannerSample
+ com.example.spanner.admin.archived.SpannerSample
true
lib/
diff --git a/samples/snippets/src/main/java/com/example/spanner/AddAndDropDatabaseRole.java b/samples/snippets/src/main/java/com/example/spanner/AddAndDropDatabaseRole.java
index 2d65974099..75e85f5f85 100644
--- a/samples/snippets/src/main/java/com/example/spanner/AddAndDropDatabaseRole.java
+++ b/samples/snippets/src/main/java/com/example/spanner/AddAndDropDatabaseRole.java
@@ -17,12 +17,12 @@
package com.example.spanner;
// [START spanner_add_and_drop_database_role]
-import com.google.api.gax.longrunning.OperationFuture;
-import com.google.cloud.spanner.DatabaseAdminClient;
+
import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerOptions;
+import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
import com.google.common.collect.ImmutableList;
-import com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata;
+import com.google.spanner.admin.database.v1.DatabaseName;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
@@ -34,54 +34,46 @@ static void addAndDropDatabaseRole() {
String projectId = "my-project";
String instanceId = "my-instance";
String databaseId = "my-database";
- String parentRole = "my-new-parent-role";
- String childRole = "my-new-child-role";
+ String parentRole = "parent_role";
+ String childRole = "child_role";
addAndDropDatabaseRole(projectId, instanceId, databaseId, parentRole, childRole);
}
static void addAndDropDatabaseRole(
- String projectId, String instanceId, String databaseId, String parentRole, String childRole) {
+ String projectId, String instanceId, String databaseId,
+ String parentRole, String childRole) {
try (Spanner spanner =
- SpannerOptions.newBuilder()
- .setProjectId(projectId)
- .build()
- .getService()) {
- final DatabaseAdminClient adminClient = spanner.getDatabaseAdminClient();
- OperationFuture operation =
- adminClient.updateDatabaseDdl(
- instanceId,
- databaseId,
+ SpannerOptions.newBuilder()
+ .setProjectId(projectId)
+ .build()
+ .getService();
+ DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
+ System.out.println("Waiting for role create operation to complete...");
+ databaseAdminClient.updateDatabaseDdlAsync(
+ DatabaseName.of(projectId, instanceId, databaseId),
ImmutableList.of(
- "CREATE ROLE " + parentRole,
- "GRANT SELECT ON TABLE Albums TO ROLE " + parentRole,
- "CREATE ROLE " + childRole,
- "GRANT ROLE " + parentRole + " TO ROLE " + childRole),
- null);
- try {
- System.out.println("Waiting for role create operation to complete...");
- operation.get(5, TimeUnit.MINUTES);
- System.out.printf(
- "Created roles %s and %s and granted privileges%n", parentRole, childRole);
- // Delete role and membership.
- operation =
- adminClient.updateDatabaseDdl(
- instanceId,
- databaseId,
- ImmutableList.of(
- "REVOKE ROLE " + parentRole + " FROM ROLE " + childRole,
- "DROP ROLE " + childRole),
- null);
- System.out.println("Waiting for role revoke & drop operation to complete...");
- operation.get(5, TimeUnit.MINUTES);
- System.out.printf("Revoked privileges and dropped role %s%n", childRole);
- } catch (ExecutionException | TimeoutException e) {
- System.out.printf(
- "Error: AddAndDropDatabaseRole failed with error message %s\n", e.getMessage());
- e.printStackTrace();
- } catch (InterruptedException e) {
- System.out.println(
- "Error: Waiting for AddAndDropDatabaseRole operation to finish was interrupted");
- }
+ String.format("CREATE ROLE %s", parentRole),
+ String.format("GRANT SELECT ON TABLE Albums TO ROLE %s", parentRole),
+ String.format("CREATE ROLE %s", childRole),
+ String.format("GRANT ROLE %s TO ROLE %s", parentRole, childRole)))
+ .get(5, TimeUnit.MINUTES);
+ System.out.printf(
+ "Created roles %s and %s and granted privileges%n", parentRole, childRole);
+ // Delete role and membership.
+ System.out.println("Waiting for role revoke & drop operation to complete...");
+ databaseAdminClient.updateDatabaseDdlAsync(
+ DatabaseName.of(projectId, instanceId, databaseId),
+ ImmutableList.of(
+ String.format("REVOKE ROLE %s FROM ROLE %s", parentRole, childRole),
+ String.format("DROP ROLE %s", childRole))).get(5, TimeUnit.MINUTES);
+ System.out.printf("Revoked privileges and dropped role %s%n", childRole);
+ } catch (ExecutionException | TimeoutException e) {
+ System.out.printf(
+ "Error: AddAndDropDatabaseRole failed with error message %s\n", e.getMessage());
+ e.printStackTrace();
+ } catch (InterruptedException e) {
+ System.out.println(
+ "Error: Waiting for AddAndDropDatabaseRole operation to finish was interrupted");
}
}
}
diff --git a/samples/snippets/src/main/java/com/example/spanner/AddJsonColumnSample.java b/samples/snippets/src/main/java/com/example/spanner/AddJsonColumnSample.java
index 8be919ddad..c87b25ff47 100644
--- a/samples/snippets/src/main/java/com/example/spanner/AddJsonColumnSample.java
+++ b/samples/snippets/src/main/java/com/example/spanner/AddJsonColumnSample.java
@@ -17,12 +17,12 @@
package com.example.spanner;
// [START spanner_add_json_column]
-import com.google.api.gax.longrunning.OperationFuture;
-import com.google.cloud.spanner.DatabaseAdminClient;
+
import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerOptions;
+import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
import com.google.common.collect.ImmutableList;
-import com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata;
+import com.google.spanner.admin.database.v1.DatabaseName;
import java.util.concurrent.ExecutionException;
class AddJsonColumnSample {
@@ -33,25 +33,24 @@ static void addJsonColumn() throws InterruptedException, ExecutionException {
String instanceId = "my-instance";
String databaseId = "my-database";
- try (Spanner spanner =
- SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
- DatabaseAdminClient adminClient = spanner.getDatabaseAdminClient();
- addJsonColumn(adminClient, instanceId, databaseId);
- }
+ addJsonColumn(projectId, instanceId, databaseId);
}
- static void addJsonColumn(DatabaseAdminClient adminClient, String instanceId, String databaseId)
+ static void addJsonColumn(String projectId, String instanceId, String databaseId)
throws InterruptedException, ExecutionException {
- OperationFuture operation =
- adminClient.updateDatabaseDdl(
- instanceId,
- databaseId,
- ImmutableList.of("ALTER TABLE Venues ADD COLUMN VenueDetails JSON"),
- null);
- // Wait for the operation to finish.
- // This will throw an ExecutionException if the operation fails.
- operation.get();
- System.out.printf("Successfully added column `VenueDetails`%n");
+ try (Spanner spanner =
+ SpannerOptions.newBuilder()
+ .setProjectId(projectId)
+ .build()
+ .getService();
+ DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
+ // Wait for the operation to finish.
+ // This will throw an ExecutionException if the operation fails.
+ databaseAdminClient.updateDatabaseDdlAsync(
+ DatabaseName.of(projectId, instanceId, databaseId),
+ ImmutableList.of("ALTER TABLE Venues ADD COLUMN VenueDetails JSON")).get();
+ System.out.printf("Successfully added column `VenueDetails`%n");
+ }
}
}
// [END spanner_add_json_column]
diff --git a/samples/snippets/src/main/java/com/example/spanner/AddJsonbColumnSample.java b/samples/snippets/src/main/java/com/example/spanner/AddJsonbColumnSample.java
index e8152c4fa0..ab2607c498 100644
--- a/samples/snippets/src/main/java/com/example/spanner/AddJsonbColumnSample.java
+++ b/samples/snippets/src/main/java/com/example/spanner/AddJsonbColumnSample.java
@@ -17,12 +17,12 @@
package com.example.spanner;
// [START spanner_postgresql_jsonb_add_column]
-import com.google.api.gax.longrunning.OperationFuture;
-import com.google.cloud.spanner.DatabaseAdminClient;
+
import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerOptions;
+import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
import com.google.common.collect.ImmutableList;
-import com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata;
+import com.google.spanner.admin.database.v1.DatabaseName;
import java.util.concurrent.ExecutionException;
class AddJsonbColumnSample {
@@ -33,25 +33,25 @@ static void addJsonbColumn() throws InterruptedException, ExecutionException {
String instanceId = "my-instance";
String databaseId = "my-database";
- try (Spanner spanner =
- SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
- DatabaseAdminClient adminClient = spanner.getDatabaseAdminClient();
- addJsonbColumn(adminClient, instanceId, databaseId);
- }
+ addJsonbColumn(projectId, instanceId, databaseId);
}
- static void addJsonbColumn(DatabaseAdminClient adminClient, String instanceId, String databaseId)
+ static void addJsonbColumn(String projectId, String instanceId, String databaseId)
throws InterruptedException, ExecutionException {
- OperationFuture operation =
- adminClient.updateDatabaseDdl(
- instanceId,
- databaseId,
- ImmutableList.of("ALTER TABLE Venues ADD COLUMN VenueDetails JSONB"),
- null);
- // Wait for the operation to finish.
- // This will throw an ExecutionException if the operation fails.
- operation.get();
- System.out.printf("Successfully added column `VenueDetails`%n");
+ try (Spanner spanner =
+ SpannerOptions.newBuilder()
+ .setProjectId(projectId)
+ .build()
+ .getService();
+ DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
+ // JSONB datatype is only supported with PostgreSQL-dialect databases.
+ // Wait for the operation to finish.
+ // This will throw an ExecutionException if the operation fails.
+ databaseAdminClient.updateDatabaseDdlAsync(
+ DatabaseName.of(projectId, instanceId, databaseId),
+ ImmutableList.of("ALTER TABLE Venues ADD COLUMN VenueDetails JSONB")).get();
+ System.out.printf("Successfully added column `VenueDetails`%n");
+ }
}
}
// [END spanner_postgresql_jsonb_add_column]
diff --git a/samples/snippets/src/main/java/com/example/spanner/AddNumericColumnSample.java b/samples/snippets/src/main/java/com/example/spanner/AddNumericColumnSample.java
index 7d29cdf15d..00cfb848e7 100644
--- a/samples/snippets/src/main/java/com/example/spanner/AddNumericColumnSample.java
+++ b/samples/snippets/src/main/java/com/example/spanner/AddNumericColumnSample.java
@@ -17,12 +17,12 @@
package com.example.spanner;
// [START spanner_add_numeric_column]
-import com.google.api.gax.longrunning.OperationFuture;
-import com.google.cloud.spanner.DatabaseAdminClient;
+
import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerOptions;
+import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
import com.google.common.collect.ImmutableList;
-import com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata;
+import com.google.spanner.admin.database.v1.DatabaseName;
import java.util.concurrent.ExecutionException;
class AddNumericColumnSample {
@@ -33,26 +33,24 @@ static void addNumericColumn() throws InterruptedException, ExecutionException {
String instanceId = "my-instance";
String databaseId = "my-database";
- try (Spanner spanner =
- SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
- DatabaseAdminClient adminClient = spanner.getDatabaseAdminClient();
- addNumericColumn(adminClient, instanceId, databaseId);
- }
+ addNumericColumn(projectId, instanceId, databaseId);
}
- static void addNumericColumn(
- DatabaseAdminClient adminClient, String instanceId, String databaseId)
+ static void addNumericColumn(String projectId, String instanceId, String databaseId)
throws InterruptedException, ExecutionException {
- OperationFuture operation =
- adminClient.updateDatabaseDdl(
- instanceId,
- databaseId,
- ImmutableList.of("ALTER TABLE Venues ADD COLUMN Revenue NUMERIC"),
- null);
- // Wait for the operation to finish.
- // This will throw an ExecutionException if the operation fails.
- operation.get();
- System.out.printf("Successfully added column `Revenue`%n");
+ try (Spanner spanner =
+ SpannerOptions.newBuilder()
+ .setProjectId(projectId)
+ .build()
+ .getService();
+ DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
+ // Wait for the operation to finish.
+ // This will throw an ExecutionException if the operation fails.
+ databaseAdminClient.updateDatabaseDdlAsync(
+ DatabaseName.of(projectId, instanceId, databaseId),
+ ImmutableList.of("ALTER TABLE Venues ADD COLUMN Revenue NUMERIC")).get();
+ System.out.printf("Successfully added column `Revenue`%n");
+ }
}
}
// [END spanner_add_numeric_column]
diff --git a/samples/snippets/src/main/java/com/example/spanner/AlterSequenceSample.java b/samples/snippets/src/main/java/com/example/spanner/AlterSequenceSample.java
index 6b9014a26f..641449ace9 100644
--- a/samples/snippets/src/main/java/com/example/spanner/AlterSequenceSample.java
+++ b/samples/snippets/src/main/java/com/example/spanner/AlterSequenceSample.java
@@ -17,7 +17,7 @@
package com.example.spanner;
// [START spanner_alter_sequence]
-import com.google.cloud.spanner.DatabaseAdminClient;
+
import com.google.cloud.spanner.DatabaseClient;
import com.google.cloud.spanner.DatabaseId;
import com.google.cloud.spanner.ResultSet;
@@ -25,13 +25,16 @@
import com.google.cloud.spanner.SpannerExceptionFactory;
import com.google.cloud.spanner.SpannerOptions;
import com.google.cloud.spanner.Statement;
+import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
import com.google.common.collect.ImmutableList;
+import com.google.spanner.admin.database.v1.DatabaseName;
import java.util.Objects;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
public class AlterSequenceSample {
+
static void alterSequence() {
// TODO(developer): Replace these variables before running the sample.
final String projectId = "my-project";
@@ -42,17 +45,14 @@ static void alterSequence() {
static void alterSequence(String projectId, String instanceId, String databaseId) {
try (Spanner spanner =
- SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
- final DatabaseAdminClient dbAdminClient = spanner.getDatabaseAdminClient();
+ SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
+ DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
- dbAdminClient
- .updateDatabaseDdl(
- instanceId,
- databaseId,
+ databaseAdminClient
+ .updateDatabaseDdlAsync(DatabaseName.of(projectId, instanceId, databaseId),
ImmutableList.of(
"ALTER SEQUENCE Seq SET OPTIONS "
- + "(skip_range_min = 1000, skip_range_max = 5000000)"),
- null)
+ + "(skip_range_min = 1000, skip_range_max = 5000000)"))
.get(5, TimeUnit.MINUTES);
System.out.println(
diff --git a/samples/snippets/src/main/java/com/example/spanner/AlterTableWithForeignKeyDeleteCascadeSample.java b/samples/snippets/src/main/java/com/example/spanner/AlterTableWithForeignKeyDeleteCascadeSample.java
index 1caf26fb28..6950e6a4fa 100644
--- a/samples/snippets/src/main/java/com/example/spanner/AlterTableWithForeignKeyDeleteCascadeSample.java
+++ b/samples/snippets/src/main/java/com/example/spanner/AlterTableWithForeignKeyDeleteCascadeSample.java
@@ -17,10 +17,12 @@
package com.example.spanner;
// [START spanner_alter_table_with_foreign_key_delete_cascade]
-import com.google.cloud.spanner.DatabaseAdminClient;
+
import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerOptions;
+import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
import com.google.common.collect.ImmutableList;
+import com.google.spanner.admin.database.v1.DatabaseName;
class AlterTableWithForeignKeyDeleteCascadeSample {
@@ -30,30 +32,28 @@ static void alterForeignKeyDeleteCascadeConstraint() {
String instanceId = "my-instance";
String databaseId = "my-database";
- try (Spanner spanner =
- SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
- DatabaseAdminClient adminClient = spanner.getDatabaseAdminClient();
- alterForeignKeyDeleteCascadeConstraint(adminClient, instanceId, databaseId);
- }
+ alterForeignKeyDeleteCascadeConstraint(projectId, instanceId, databaseId);
}
static void alterForeignKeyDeleteCascadeConstraint(
- DatabaseAdminClient adminClient, String instanceId, String databaseId) {
- adminClient.updateDatabaseDdl(
- instanceId,
- databaseId,
- ImmutableList.of(
- "ALTER TABLE ShoppingCarts\n"
- + " ADD CONSTRAINT FKShoppingCartsCustomerName\n"
- + " FOREIGN KEY (CustomerName)\n"
- + " REFERENCES Customers(CustomerName)\n"
- + " ON DELETE CASCADE\n"),
- null);
- System.out.printf(
- String.format(
- "Altered ShoppingCarts table with FKShoppingCartsCustomerName\n"
- + "foreign key constraint on database %s on instance %s",
- databaseId, instanceId));
+ String projectId, String instanceId, String databaseId) {
+ try (Spanner spanner =
+ SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
+ DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
+ databaseAdminClient.updateDatabaseDdlAsync(DatabaseName.of(projectId, instanceId,
+ databaseId),
+ ImmutableList.of(
+ "ALTER TABLE ShoppingCarts\n"
+ + " ADD CONSTRAINT FKShoppingCartsCustomerName\n"
+ + " FOREIGN KEY (CustomerName)\n"
+ + " REFERENCES Customers(CustomerName)\n"
+ + " ON DELETE CASCADE\n"));
+ System.out.printf(
+ String.format(
+ "Altered ShoppingCarts table with FKShoppingCartsCustomerName\n"
+ + "foreign key constraint on database %s on instance %s",
+ databaseId, instanceId));
+ }
}
}
// [END spanner_alter_table_with_foreign_key_delete_cascade]
diff --git a/samples/snippets/src/main/java/com/example/spanner/CopyBackupSample.java b/samples/snippets/src/main/java/com/example/spanner/CopyBackupSample.java
index 795edcb15a..c6ee706687 100644
--- a/samples/snippets/src/main/java/com/example/spanner/CopyBackupSample.java
+++ b/samples/snippets/src/main/java/com/example/spanner/CopyBackupSample.java
@@ -18,84 +18,80 @@
// [START spanner_copy_backup]
-import com.google.api.gax.longrunning.OperationFuture;
import com.google.cloud.Timestamp;
-import com.google.cloud.spanner.Backup;
-import com.google.cloud.spanner.BackupId;
-import com.google.cloud.spanner.DatabaseAdminClient;
import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerException;
import com.google.cloud.spanner.SpannerExceptionFactory;
import com.google.cloud.spanner.SpannerOptions;
-import com.google.spanner.admin.database.v1.CopyBackupMetadata;
-import java.time.LocalDateTime;
+import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
+import com.google.spanner.admin.database.v1.Backup;
+import com.google.spanner.admin.database.v1.BackupName;
+import com.google.spanner.admin.database.v1.InstanceName;
+import java.time.Instant;
import java.time.OffsetDateTime;
+import java.time.ZoneId;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
public class CopyBackupSample {
+
static void copyBackup() {
// TODO(developer): Replace these variables before running the sample.
String projectId = "my-project";
String instanceId = "my-instance";
String sourceBackupId = "my-backup";
String destinationBackupId = "my-destination-backup";
+
try (Spanner spanner =
- SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
- DatabaseAdminClient databaseAdminClient = spanner.getDatabaseAdminClient();
+ SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
+ DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
copyBackup(databaseAdminClient, projectId, instanceId, sourceBackupId, destinationBackupId);
}
}
static void copyBackup(
- DatabaseAdminClient databaseAdminClient,
- String projectId,
- String instanceId,
- String sourceBackupId,
- String destinationBackupId) {
+ DatabaseAdminClient databaseAdminClient,
+ String projectId,
+ String instanceId,
+ String sourceBackupId,
+ String destinationBackupId) {
Timestamp expireTime =
- Timestamp.ofTimeMicroseconds(
- TimeUnit.MICROSECONDS.convert(
- System.currentTimeMillis() + TimeUnit.DAYS.toMillis(14),
- TimeUnit.MILLISECONDS));
- // Creates a copy of an existing backup.
- Backup destinationBackup =
- databaseAdminClient
- .newBackupBuilder(BackupId.of(projectId, instanceId, destinationBackupId))
- .setExpireTime(expireTime)
- .build();
+ Timestamp.ofTimeMicroseconds(
+ TimeUnit.MICROSECONDS.convert(
+ System.currentTimeMillis() + TimeUnit.DAYS.toMillis(14),
+ TimeUnit.MILLISECONDS));
// Initiate the request which returns an OperationFuture.
- System.out.println("Copying backup [" + destinationBackup.getId() + "]...");
- OperationFuture operation =
- databaseAdminClient.copyBackup(
- BackupId.of(projectId, instanceId, sourceBackupId), destinationBackup);
+ System.out.println("Copying backup [" + destinationBackupId + "]...");
+ Backup destinationBackup;
try {
+ // Creates a copy of an existing backup.
// Wait for the backup operation to complete.
- destinationBackup = operation.get();
- System.out.println("Copied backup [" + destinationBackup.getId() + "]");
+ destinationBackup = databaseAdminClient.copyBackupAsync(
+ InstanceName.of(projectId, instanceId), destinationBackupId,
+ BackupName.of(projectId, instanceId, sourceBackupId), expireTime.toProto()).get();
+ System.out.println("Copied backup [" + destinationBackup.getName() + "]");
} catch (ExecutionException e) {
throw (SpannerException) e.getCause();
} catch (InterruptedException e) {
throw SpannerExceptionFactory.propagateInterrupt(e);
}
// Load the metadata of the new backup from the server.
- destinationBackup = destinationBackup.reload();
+ destinationBackup = databaseAdminClient.getBackup(destinationBackup.getName());
System.out.println(
- String.format(
- "Backup %s of size %d bytes was copied at %s for version of database at %s",
- destinationBackup.getId().getName(),
- destinationBackup.getSize(),
- LocalDateTime.ofEpochSecond(
- destinationBackup.getProto().getCreateTime().getSeconds(),
- destinationBackup.getProto().getCreateTime().getNanos(),
- OffsetDateTime.now().getOffset()),
- LocalDateTime.ofEpochSecond(
- destinationBackup.getProto().getVersionTime().getSeconds(),
- destinationBackup.getProto().getVersionTime().getNanos(),
- OffsetDateTime.now().getOffset())));
- return;
+ String.format(
+ "Backup %s of size %d bytes was copied at %s for version of database at %s",
+ destinationBackup.getName(),
+ destinationBackup.getSizeBytes(),
+ OffsetDateTime.ofInstant(
+ Instant.ofEpochSecond(destinationBackup.getCreateTime().getSeconds(),
+ destinationBackup.getCreateTime().getNanos()),
+ ZoneId.systemDefault()),
+ OffsetDateTime.ofInstant(
+ Instant.ofEpochSecond(destinationBackup.getVersionTime().getSeconds(),
+ destinationBackup.getVersionTime().getNanos()),
+ ZoneId.systemDefault())));
}
}
// [END spanner_copy_backup]
diff --git a/samples/snippets/src/main/java/com/example/spanner/CreateBackupWithEncryptionKey.java b/samples/snippets/src/main/java/com/example/spanner/CreateBackupWithEncryptionKey.java
index b2a00ae2ad..e2c7b17061 100644
--- a/samples/snippets/src/main/java/com/example/spanner/CreateBackupWithEncryptionKey.java
+++ b/samples/snippets/src/main/java/com/example/spanner/CreateBackupWithEncryptionKey.java
@@ -18,17 +18,18 @@
// [START spanner_create_backup_with_encryption_key]
-import com.google.api.gax.longrunning.OperationFuture;
-import com.google.cloud.Timestamp;
-import com.google.cloud.spanner.Backup;
-import com.google.cloud.spanner.BackupId;
-import com.google.cloud.spanner.DatabaseAdminClient;
-import com.google.cloud.spanner.DatabaseId;
import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerExceptionFactory;
import com.google.cloud.spanner.SpannerOptions;
-import com.google.cloud.spanner.encryption.EncryptionConfigs;
-import com.google.spanner.admin.database.v1.CreateBackupMetadata;
+import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
+import com.google.protobuf.Timestamp;
+import com.google.spanner.admin.database.v1.Backup;
+import com.google.spanner.admin.database.v1.BackupName;
+import com.google.spanner.admin.database.v1.CreateBackupEncryptionConfig;
+import com.google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType;
+import com.google.spanner.admin.database.v1.CreateBackupRequest;
+import com.google.spanner.admin.database.v1.DatabaseName;
+import com.google.spanner.admin.database.v1.InstanceName;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
@@ -37,7 +38,7 @@
public class CreateBackupWithEncryptionKey {
- static void createBackupWithEncryptionKey() throws InterruptedException {
+ static void createBackupWithEncryptionKey() {
// TODO(developer): Replace these variables before running the sample.
String projectId = "my-project";
String instanceId = "my-instance";
@@ -47,8 +48,8 @@ static void createBackupWithEncryptionKey() throws InterruptedException {
"projects/" + projectId + "/locations//keyRings//cryptoKeys/";
try (Spanner spanner =
- SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
- DatabaseAdminClient adminClient = spanner.getDatabaseAdminClient();
+ SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
+ DatabaseAdminClient adminClient = spanner.createDatabaseAdminClient()) {
createBackupWithEncryptionKey(
adminClient,
projectId,
@@ -60,24 +61,29 @@ static void createBackupWithEncryptionKey() throws InterruptedException {
}
static Void createBackupWithEncryptionKey(DatabaseAdminClient adminClient,
- String projectId, String instanceId, String databaseId, String backupId, String kmsKeyName)
- throws InterruptedException {
+ String projectId, String instanceId, String databaseId, String backupId, String kmsKeyName) {
// Set expire time to 14 days from now.
- final Timestamp expireTime = Timestamp.ofTimeMicroseconds(TimeUnit.MICROSECONDS.convert(
- System.currentTimeMillis() + TimeUnit.DAYS.toMillis(14), TimeUnit.MILLISECONDS));
- final Backup backupToCreate = adminClient
- .newBackupBuilder(BackupId.of(projectId, instanceId, backupId))
- .setDatabase(DatabaseId.of(projectId, instanceId, databaseId))
- .setExpireTime(expireTime)
- .setEncryptionConfig(EncryptionConfigs.customerManagedEncryption(kmsKeyName))
- .build();
- final OperationFuture operation = adminClient
- .createBackup(backupToCreate);
+ final Timestamp expireTime =
+ Timestamp.newBuilder().setSeconds(TimeUnit.MILLISECONDS.toSeconds((
+ System.currentTimeMillis() + TimeUnit.DAYS.toMillis(14)))).build();
+ final BackupName backupName = BackupName.of(projectId, instanceId, backupId);
+ Backup backup = Backup.newBuilder()
+ .setName(backupName.toString())
+ .setDatabase(DatabaseName.of(projectId, instanceId, databaseId).toString())
+ .setExpireTime(expireTime).build();
- Backup backup;
+ final CreateBackupRequest request =
+ CreateBackupRequest.newBuilder()
+ .setParent(InstanceName.of(projectId, instanceId).toString())
+ .setBackupId(backupId)
+ .setBackup(backup)
+ .setEncryptionConfig(
+ CreateBackupEncryptionConfig.newBuilder()
+ .setEncryptionType(EncryptionType.CUSTOMER_MANAGED_ENCRYPTION)
+ .setKmsKeyName(kmsKeyName).build()).build();
try {
System.out.println("Waiting for operation to complete...");
- backup = operation.get(1200, TimeUnit.SECONDS);
+ backup = adminClient.createBackupAsync(request).get(1200, TimeUnit.SECONDS);
} catch (ExecutionException e) {
// If the operation failed during execution, expose the cause.
throw SpannerExceptionFactory.asSpannerException(e.getCause());
@@ -89,14 +95,13 @@ static Void createBackupWithEncryptionKey(DatabaseAdminClient adminClient,
// If the operation timed out propagates the timeout
throw SpannerExceptionFactory.propagateTimeout(e);
}
-
System.out.printf(
"Backup %s of size %d bytes was created at %s using encryption key %s%n",
- backup.getId().getName(),
- backup.getSize(),
+ backup.getName(),
+ backup.getSizeBytes(),
LocalDateTime.ofEpochSecond(
- backup.getProto().getCreateTime().getSeconds(),
- backup.getProto().getCreateTime().getNanos(),
+ backup.getCreateTime().getSeconds(),
+ backup.getCreateTime().getNanos(),
OffsetDateTime.now().getOffset()),
kmsKeyName
);
diff --git a/samples/snippets/src/main/java/com/example/spanner/CreateDatabaseWithDefaultLeaderSample.java b/samples/snippets/src/main/java/com/example/spanner/CreateDatabaseWithDefaultLeaderSample.java
index fa3354dd9c..33917685cd 100644
--- a/samples/snippets/src/main/java/com/example/spanner/CreateDatabaseWithDefaultLeaderSample.java
+++ b/samples/snippets/src/main/java/com/example/spanner/CreateDatabaseWithDefaultLeaderSample.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2021 Google LLC
+ * Copyright 2023 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
@@ -18,60 +18,51 @@
//[START spanner_create_database_with_default_leader]
-import com.google.api.gax.longrunning.OperationFuture;
-import com.google.cloud.spanner.Database;
-import com.google.cloud.spanner.DatabaseAdminClient;
-import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerException;
import com.google.cloud.spanner.SpannerExceptionFactory;
-import com.google.cloud.spanner.SpannerOptions;
-import com.google.spanner.admin.database.v1.CreateDatabaseMetadata;
-import java.util.Arrays;
+import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
+import com.google.common.collect.ImmutableList;
+import com.google.spanner.admin.database.v1.CreateDatabaseRequest;
+import com.google.spanner.admin.database.v1.Database;
+import java.io.IOException;
import java.util.concurrent.ExecutionException;
public class CreateDatabaseWithDefaultLeaderSample {
- static void createDatabaseWithDefaultLeader() {
+ static void createDatabaseWithDefaultLeader() throws IOException {
// TODO(developer): Replace these variables before running the sample.
- final String projectId = "my-project";
- final String instanceId = "my-instance";
- final String databaseId = "my-database";
+ final String instanceName = "projects/my-project/instances/my-instance-id";
+ final String databaseId = "my-database-name";
final String defaultLeader = "my-default-leader";
- createDatabaseWithDefaultLeader(projectId, instanceId, databaseId, defaultLeader);
+ createDatabaseWithDefaultLeader(instanceName, databaseId, defaultLeader);
}
- static void createDatabaseWithDefaultLeader(
- String projectId, String instanceId, String databaseId, String defaultLeader) {
- try (Spanner spanner = SpannerOptions
- .newBuilder()
- .setProjectId(projectId)
- .build()
- .getService()) {
- final DatabaseAdminClient databaseAdminClient = spanner.getDatabaseAdminClient();
- final OperationFuture operation = databaseAdminClient
- .createDatabase(
- instanceId,
- databaseId,
- Arrays.asList(
- "CREATE TABLE Singers ("
- + " SingerId INT64 NOT NULL,"
- + " FirstName STRING(1024),"
- + " LastName STRING(1024),"
- + " SingerInfo BYTES(MAX)"
- + ") PRIMARY KEY (SingerId)",
- "CREATE TABLE Albums ("
- + " SingerId INT64 NOT NULL,"
- + " AlbumId INT64 NOT NULL,"
- + " AlbumTitle STRING(MAX)"
- + ") PRIMARY KEY (SingerId, AlbumId),"
- + " INTERLEAVE IN PARENT Singers ON DELETE CASCADE",
- "ALTER DATABASE " + "`" + databaseId + "`"
- + " SET OPTIONS ( default_leader = '" + defaultLeader + "' )"
- )
- );
- final Database database = operation.get();
- System.out.println("Created database [" + database.getId() + "]");
- System.out.println("\tDefault leader: " + database.getDefaultLeader());
+ static void createDatabaseWithDefaultLeader(String instanceName, String databaseId,
+ String defaultLeader) throws IOException {
+ try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ Database createdDatabase =
+ databaseAdminClient.createDatabaseAsync(
+ CreateDatabaseRequest.newBuilder()
+ .setParent(instanceName)
+ .setCreateStatement("CREATE DATABASE `" + databaseId + "`")
+ .addAllExtraStatements(
+ ImmutableList.of("CREATE TABLE Singers ("
+ + " SingerId INT64 NOT NULL,"
+ + " FirstName STRING(1024),"
+ + " LastName STRING(1024),"
+ + " SingerInfo BYTES(MAX)"
+ + ") PRIMARY KEY (SingerId)",
+ "CREATE TABLE Albums ("
+ + " SingerId INT64 NOT NULL,"
+ + " AlbumId INT64 NOT NULL,"
+ + " AlbumTitle STRING(MAX)"
+ + ") PRIMARY KEY (SingerId, AlbumId),"
+ + " INTERLEAVE IN PARENT Singers ON DELETE CASCADE",
+ "ALTER DATABASE " + "`" + databaseId + "`"
+ + " SET OPTIONS ( default_leader = '" + defaultLeader + "' )"))
+ .build()).get();
+ System.out.println("Created database [" + createdDatabase.getName() + "]");
+ System.out.println("\tDefault leader: " + createdDatabase.getDefaultLeader());
} catch (ExecutionException e) {
// If the operation failed during execution, expose the cause.
throw (SpannerException) e.getCause();
@@ -82,4 +73,4 @@ static void createDatabaseWithDefaultLeader(
}
}
}
-//[END spanner_create_database_with_default_leader]
+//[END spanner_create_database_with_default_leader]
\ No newline at end of file
diff --git a/samples/snippets/src/main/java/com/example/spanner/CreateDatabaseWithEncryptionKey.java b/samples/snippets/src/main/java/com/example/spanner/CreateDatabaseWithEncryptionKey.java
index 7d3850933b..c06e9c3eba 100644
--- a/samples/snippets/src/main/java/com/example/spanner/CreateDatabaseWithEncryptionKey.java
+++ b/samples/snippets/src/main/java/com/example/spanner/CreateDatabaseWithEncryptionKey.java
@@ -18,16 +18,15 @@
// [START spanner_create_database_with_encryption_key]
-import com.google.api.gax.longrunning.OperationFuture;
-import com.google.cloud.spanner.Database;
-import com.google.cloud.spanner.DatabaseAdminClient;
-import com.google.cloud.spanner.DatabaseId;
import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerExceptionFactory;
import com.google.cloud.spanner.SpannerOptions;
-import com.google.cloud.spanner.encryption.EncryptionConfigs;
-import com.google.spanner.admin.database.v1.CreateDatabaseMetadata;
-import java.util.Arrays;
+import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
+import com.google.common.collect.ImmutableList;
+import com.google.spanner.admin.database.v1.CreateDatabaseRequest;
+import com.google.spanner.admin.database.v1.Database;
+import com.google.spanner.admin.database.v1.EncryptionConfig;
+import com.google.spanner.admin.database.v1.InstanceName;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
@@ -43,8 +42,8 @@ static void createDatabaseWithEncryptionKey() {
"projects/" + projectId + "/locations//keyRings//cryptoKeys/";
try (Spanner spanner =
- SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
- DatabaseAdminClient adminClient = spanner.getDatabaseAdminClient();
+ SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
+ DatabaseAdminClient adminClient = spanner.createDatabaseAdminClient()) {
createDatabaseWithEncryptionKey(
adminClient,
projectId,
@@ -56,32 +55,35 @@ static void createDatabaseWithEncryptionKey() {
static void createDatabaseWithEncryptionKey(DatabaseAdminClient adminClient,
String projectId, String instanceId, String databaseId, String kmsKeyName) {
- final Database databaseToCreate = adminClient
- .newDatabaseBuilder(DatabaseId.of(projectId, instanceId, databaseId))
- .setEncryptionConfig(EncryptionConfigs.customerManagedEncryption(kmsKeyName))
+ InstanceName instanceName = InstanceName.of(projectId, instanceId);
+ CreateDatabaseRequest request = CreateDatabaseRequest.newBuilder()
+ .setParent(instanceName.toString())
+ .setCreateStatement("CREATE DATABASE `" + databaseId + "`")
+ .setEncryptionConfig(EncryptionConfig.newBuilder().setKmsKeyName(kmsKeyName).build())
+ .addAllExtraStatements(
+ ImmutableList.of(
+ "CREATE TABLE Singers ("
+ + " SingerId INT64 NOT NULL,"
+ + " FirstName STRING(1024),"
+ + " LastName STRING(1024),"
+ + " SingerInfo BYTES(MAX)"
+ + ") PRIMARY KEY (SingerId)",
+ "CREATE TABLE Albums ("
+ + " SingerId INT64 NOT NULL,"
+ + " AlbumId INT64 NOT NULL,"
+ + " AlbumTitle STRING(MAX)"
+ + ") PRIMARY KEY (SingerId, AlbumId),"
+ + " INTERLEAVE IN PARENT Singers ON DELETE CASCADE"
+ ))
.build();
- final OperationFuture operation = adminClient
- .createDatabase(databaseToCreate, Arrays.asList(
- "CREATE TABLE Singers ("
- + " SingerId INT64 NOT NULL,"
- + " FirstName STRING(1024),"
- + " LastName STRING(1024),"
- + " SingerInfo BYTES(MAX)"
- + ") PRIMARY KEY (SingerId)",
- "CREATE TABLE Albums ("
- + " SingerId INT64 NOT NULL,"
- + " AlbumId INT64 NOT NULL,"
- + " AlbumTitle STRING(MAX)"
- + ") PRIMARY KEY (SingerId, AlbumId),"
- + " INTERLEAVE IN PARENT Singers ON DELETE CASCADE"
- ));
try {
System.out.println("Waiting for operation to complete...");
- Database createdDatabase = operation.get(120, TimeUnit.SECONDS);
+ Database createdDatabase =
+ adminClient.createDatabaseAsync(request).get(120, TimeUnit.SECONDS);
System.out.printf(
"Database %s created with encryption key %s%n",
- createdDatabase.getId(),
+ createdDatabase.getName(),
createdDatabase.getEncryptionConfig().getKmsKeyName()
);
} catch (ExecutionException e) {
diff --git a/samples/snippets/src/main/java/com/example/spanner/CreateDatabaseWithVersionRetentionPeriodSample.java b/samples/snippets/src/main/java/com/example/spanner/CreateDatabaseWithVersionRetentionPeriodSample.java
index 1eaa7c403d..888fe62588 100644
--- a/samples/snippets/src/main/java/com/example/spanner/CreateDatabaseWithVersionRetentionPeriodSample.java
+++ b/samples/snippets/src/main/java/com/example/spanner/CreateDatabaseWithVersionRetentionPeriodSample.java
@@ -18,15 +18,15 @@
// [START spanner_create_database_with_version_retention_period]
-import com.google.api.gax.longrunning.OperationFuture;
-import com.google.cloud.spanner.Database;
-import com.google.cloud.spanner.DatabaseAdminClient;
import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerException;
import com.google.cloud.spanner.SpannerExceptionFactory;
import com.google.cloud.spanner.SpannerOptions;
-import com.google.spanner.admin.database.v1.CreateDatabaseMetadata;
-import java.util.Arrays;
+import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
+import com.google.common.collect.Lists;
+import com.google.spanner.admin.database.v1.CreateDatabaseRequest;
+import com.google.spanner.admin.database.v1.Database;
+import com.google.spanner.admin.database.v1.InstanceName;
import java.util.concurrent.ExecutionException;
public class CreateDatabaseWithVersionRetentionPeriodSample {
@@ -38,39 +38,25 @@ static void createDatabaseWithVersionRetentionPeriod() {
String databaseId = "my-database";
String versionRetentionPeriod = "7d";
- try (Spanner spanner =
- SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
- DatabaseAdminClient adminClient = spanner.getDatabaseAdminClient();
- createDatabaseWithVersionRetentionPeriod(adminClient, instanceId, databaseId,
- versionRetentionPeriod);
- }
+ createDatabaseWithVersionRetentionPeriod(projectId, instanceId, databaseId,
+ versionRetentionPeriod);
}
- static void createDatabaseWithVersionRetentionPeriod(DatabaseAdminClient adminClient,
+ static void createDatabaseWithVersionRetentionPeriod(String projectId,
String instanceId, String databaseId, String versionRetentionPeriod) {
- OperationFuture op =
- adminClient.createDatabase(
- instanceId,
- databaseId,
- Arrays.asList(
- "CREATE TABLE Singers ("
- + " SingerId INT64 NOT NULL,"
- + " FirstName STRING(1024),"
- + " LastName STRING(1024),"
- + " SingerInfo BYTES(MAX)"
- + ") PRIMARY KEY (SingerId)",
- "CREATE TABLE Albums ("
- + " SingerId INT64 NOT NULL,"
- + " AlbumId INT64 NOT NULL,"
- + " AlbumTitle STRING(MAX)"
- + ") PRIMARY KEY (SingerId, AlbumId),"
- + " INTERLEAVE IN PARENT Singers ON DELETE CASCADE",
- "ALTER DATABASE " + "`" + databaseId + "`"
- + " SET OPTIONS ( version_retention_period = '" + versionRetentionPeriod + "' )"
- ));
- try {
- Database database = op.get();
- System.out.println("Created database [" + database.getId() + "]");
+ try (Spanner spanner =
+ SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
+ DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
+ CreateDatabaseRequest request =
+ CreateDatabaseRequest.newBuilder()
+ .setParent(InstanceName.of(projectId, instanceId).toString())
+ .setCreateStatement("CREATE DATABASE `" + databaseId + "`")
+ .addAllExtraStatements(Lists.newArrayList("ALTER DATABASE " + "`" + databaseId + "`"
+ + " SET OPTIONS ( version_retention_period = '" + versionRetentionPeriod + "' )"))
+ .build();
+ Database database =
+ databaseAdminClient.createDatabaseAsync(request).get();
+ System.out.println("Created database [" + database.getName() + "]");
System.out.println("\tVersion retention period: " + database.getVersionRetentionPeriod());
System.out.println("\tEarliest version time: " + database.getEarliestVersionTime());
} catch (ExecutionException e) {
diff --git a/samples/snippets/src/main/java/com/example/spanner/CreateInstanceConfigSample.java b/samples/snippets/src/main/java/com/example/spanner/CreateInstanceConfigSample.java
index 379e0e2617..426d7c0484 100644
--- a/samples/snippets/src/main/java/com/example/spanner/CreateInstanceConfigSample.java
+++ b/samples/snippets/src/main/java/com/example/spanner/CreateInstanceConfigSample.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2022 Google LLC
+ * Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,53 +17,73 @@
package com.example.spanner;
// [START spanner_create_instance_config]
-import com.google.api.gax.longrunning.OperationFuture;
-import com.google.cloud.spanner.InstanceAdminClient;
-import com.google.cloud.spanner.InstanceConfig;
-import com.google.cloud.spanner.InstanceConfigId;
-import com.google.cloud.spanner.InstanceConfigInfo;
-import com.google.cloud.spanner.ReplicaInfo;
+
import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerOptions;
-import com.google.common.collect.ImmutableList;
-import com.google.spanner.admin.instance.v1.CreateInstanceConfigMetadata;
+import com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient;
+import com.google.spanner.admin.instance.v1.CreateInstanceConfigRequest;
+import com.google.spanner.admin.instance.v1.InstanceConfig;
+import com.google.spanner.admin.instance.v1.InstanceConfigName;
+import com.google.spanner.admin.instance.v1.ProjectName;
+import com.google.spanner.admin.instance.v1.ReplicaInfo;
import java.util.List;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
class CreateInstanceConfigSample {
+
static void createInstanceConfig() {
// TODO(developer): Replace these variables before running the sample.
String projectId = "my-project";
- String baseInstanceConfig = "my-base-instance-config";
+ String baseInstanceConfigId = "nam11";
String instanceConfigId = "custom-instance-config4";
- createInstanceConfig(projectId, baseInstanceConfig, instanceConfigId);
+
+ createInstanceConfig(projectId, baseInstanceConfigId, instanceConfigId);
}
static void createInstanceConfig(
- String projectId, String baseInstanceConfig, String instanceConfigId) {
+ String projectId, String baseInstanceConfigId, String instanceConfigId) {
try (Spanner spanner =
- SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
- final InstanceAdminClient instanceAdminClient = spanner.getInstanceAdminClient();
- final InstanceConfig baseConfig = instanceAdminClient.getInstanceConfig(baseInstanceConfig);
- List readOnlyReplicas =
- ImmutableList.of(baseConfig.getOptionalReplicas().get(0));
- InstanceConfigInfo instanceConfigInfo =
- InstanceConfig.newBuilder(InstanceConfigId.of(projectId, instanceConfigId), baseConfig)
- .setDisplayName(instanceConfigId)
- .addReadOnlyReplicas(readOnlyReplicas)
- .build();
- final OperationFuture operation =
- instanceAdminClient.createInstanceConfig(instanceConfigInfo);
+ SpannerOptions.newBuilder()
+ .setProjectId(projectId)
+ .build()
+ .getService();
+ InstanceAdminClient instanceAdminClient = spanner.createInstanceAdminClient()) {
+ final InstanceConfigName baseInstanceConfigName = InstanceConfigName.of(projectId,
+ baseInstanceConfigId);
+ final InstanceConfig baseConfig =
+ instanceAdminClient.getInstanceConfig(baseInstanceConfigName.toString());
+ final InstanceConfigName instanceConfigName = InstanceConfigName.of(projectId,
+ instanceConfigId);
+ /**
+ * The replicas for the custom instance configuration must include all the replicas of the
+ * base configuration, in addition to at least one from the list of optional replicas of the
+ * base configuration.
+ */
+ final List replicas =
+ Stream.concat(baseConfig.getReplicasList().stream(),
+ baseConfig.getOptionalReplicasList().stream().limit(1)).collect(Collectors.toList());
+ final InstanceConfig instanceConfig =
+ InstanceConfig.newBuilder().setName(instanceConfigName.toString())
+ .setBaseConfig(baseInstanceConfigName.toString())
+ .setDisplayName("Instance Configuration").addAllReplicas(replicas).build();
+ final CreateInstanceConfigRequest createInstanceConfigRequest =
+ CreateInstanceConfigRequest.newBuilder().setParent(ProjectName.of(projectId).toString())
+ .setInstanceConfigId(instanceConfigId).setInstanceConfig(instanceConfig).build();
try {
- System.out.printf("Waiting for create operation for %s to complete...\n", instanceConfigId);
- InstanceConfig instanceConfig = operation.get(5, TimeUnit.MINUTES);
- System.out.printf("Created instance configuration %s\n", instanceConfig.getId());
+ System.out.printf("Waiting for create operation for %s to complete...\n",
+ instanceConfigName);
+ InstanceConfig instanceConfigResult =
+ instanceAdminClient.createInstanceConfigAsync(
+ createInstanceConfigRequest).get(5, TimeUnit.MINUTES);
+ System.out.printf("Created instance configuration %s\n", instanceConfigResult.getName());
} catch (ExecutionException | TimeoutException e) {
System.out.printf(
"Error: Creating instance configuration %s failed with error message %s\n",
- instanceConfigInfo.getId(), e.getMessage());
+ instanceConfig.getName(), e.getMessage());
} catch (InterruptedException e) {
System.out.println(
"Error: Waiting for createInstanceConfig operation to finish was interrupted");
diff --git a/samples/snippets/src/main/java/com/example/spanner/CreateInstanceExample.java b/samples/snippets/src/main/java/com/example/spanner/CreateInstanceExample.java
index 44e36a8b27..b53727ba6d 100644
--- a/samples/snippets/src/main/java/com/example/spanner/CreateInstanceExample.java
+++ b/samples/snippets/src/main/java/com/example/spanner/CreateInstanceExample.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2020 Google LLC
+ * Copyright 2023 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,15 +17,14 @@
package com.example.spanner;
//[START spanner_create_instance]
-import com.google.api.gax.longrunning.OperationFuture;
-import com.google.cloud.spanner.Instance;
-import com.google.cloud.spanner.InstanceAdminClient;
-import com.google.cloud.spanner.InstanceConfigId;
-import com.google.cloud.spanner.InstanceId;
-import com.google.cloud.spanner.InstanceInfo;
+
import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerOptions;
-import com.google.spanner.admin.instance.v1.CreateInstanceMetadata;
+import com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient;
+import com.google.spanner.admin.instance.v1.CreateInstanceRequest;
+import com.google.spanner.admin.instance.v1.Instance;
+import com.google.spanner.admin.instance.v1.InstanceConfigName;
+import com.google.spanner.admin.instance.v1.ProjectName;
import java.util.concurrent.ExecutionException;
class CreateInstanceExample {
@@ -38,36 +37,41 @@ static void createInstance() {
}
static void createInstance(String projectId, String instanceId) {
- Spanner spanner = SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
- InstanceAdminClient instanceAdminClient = spanner.getInstanceAdminClient();
-
// Set Instance configuration.
- String configId = "regional-us-central1";
int nodeCount = 2;
String displayName = "Descriptive name";
- // Create an InstanceInfo object that will be used to create the instance.
- InstanceInfo instanceInfo =
- InstanceInfo.newBuilder(InstanceId.of(projectId, instanceId))
- .setInstanceConfigId(InstanceConfigId.of(projectId, configId))
- .setNodeCount(nodeCount)
+ // Create an Instance object that will be used to create the instance.
+ Instance instance =
+ Instance.newBuilder()
.setDisplayName(displayName)
+ .setNodeCount(nodeCount)
+ .setConfig(
+ InstanceConfigName.of(projectId, "regional-us-central1").toString())
.build();
- OperationFuture operation =
- instanceAdminClient.createInstance(instanceInfo);
- try {
+
+ try (Spanner spanner =
+ SpannerOptions.newBuilder()
+ .setProjectId(projectId)
+ .build()
+ .getService();
+ InstanceAdminClient instanceAdminClient = spanner.createInstanceAdminClient()) {
+
// Wait for the createInstance operation to finish.
- Instance instance = operation.get();
- System.out.printf("Instance %s was successfully created%n", instance.getId());
+ Instance createdInstance = instanceAdminClient.createInstanceAsync(
+ CreateInstanceRequest.newBuilder()
+ .setParent(ProjectName.of(projectId).toString())
+ .setInstanceId(instanceId)
+ .setInstance(instance)
+ .build()).get();
+ System.out.printf("Instance %s was successfully created%n", createdInstance.getName());
} catch (ExecutionException e) {
System.out.printf(
"Error: Creating instance %s failed with error message %s%n",
- instanceInfo.getId(), e.getMessage());
+ instance.getName(), e.getMessage());
} catch (InterruptedException e) {
System.out.println("Error: Waiting for createInstance operation to finish was interrupted");
- } finally {
- spanner.close();
}
}
}
-//[END spanner_create_instance]
+//[END spanner_create_instance]
\ No newline at end of file
diff --git a/samples/snippets/src/main/java/com/example/spanner/CreateInstanceWithAutoscalingConfigExample.java b/samples/snippets/src/main/java/com/example/spanner/CreateInstanceWithAutoscalingConfigExample.java
index 0719857411..dc62dd7a68 100644
--- a/samples/snippets/src/main/java/com/example/spanner/CreateInstanceWithAutoscalingConfigExample.java
+++ b/samples/snippets/src/main/java/com/example/spanner/CreateInstanceWithAutoscalingConfigExample.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -18,16 +18,14 @@
// [START spanner_create_instance_with_autoscaling_config]
-import com.google.api.gax.longrunning.OperationFuture;
-import com.google.cloud.spanner.Instance;
-import com.google.cloud.spanner.InstanceAdminClient;
-import com.google.cloud.spanner.InstanceConfigId;
-import com.google.cloud.spanner.InstanceId;
-import com.google.cloud.spanner.InstanceInfo;
import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerOptions;
+import com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient;
import com.google.spanner.admin.instance.v1.AutoscalingConfig;
-import com.google.spanner.admin.instance.v1.CreateInstanceMetadata;
+import com.google.spanner.admin.instance.v1.CreateInstanceRequest;
+import com.google.spanner.admin.instance.v1.Instance;
+import com.google.spanner.admin.instance.v1.InstanceConfigName;
+import com.google.spanner.admin.instance.v1.ProjectName;
import java.util.concurrent.ExecutionException;
class CreateInstanceWithAutoscalingConfigExample {
@@ -40,44 +38,55 @@ static void createInstance() {
}
static void createInstance(String projectId, String instanceId) {
- Spanner spanner = SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
- InstanceAdminClient instanceAdminClient = spanner.getInstanceAdminClient();
+ try (Spanner spanner =
+ SpannerOptions.newBuilder()
+ .setProjectId(projectId)
+ .build()
+ .getService();
+ InstanceAdminClient instanceAdminClient = spanner.createInstanceAdminClient()) {
+ // Set Instance configuration.
+ String configId = "regional-us-central1";
+ String displayName = "Descriptive name";
- // Set Instance configuration.
- String configId = "regional-us-central1";
- // Create an autoscaling config.
- AutoscalingConfig autoscalingConfig =
- AutoscalingConfig.newBuilder()
- .setAutoscalingLimits(
- AutoscalingConfig.AutoscalingLimits.newBuilder().setMinNodes(1).setMaxNodes(2))
- .setAutoscalingTargets(
- AutoscalingConfig.AutoscalingTargets.newBuilder()
- .setHighPriorityCpuUtilizationPercent(65)
- .setStorageUtilizationPercent(95))
- .build();
+ // Create an autoscaling config.
+ // When autoscaling_config is enabled, node_count and processing_units fields
+ // need not be specified.
+ AutoscalingConfig autoscalingConfig =
+ AutoscalingConfig.newBuilder()
+ .setAutoscalingLimits(
+ AutoscalingConfig.AutoscalingLimits.newBuilder().setMinNodes(1).setMaxNodes(2))
+ .setAutoscalingTargets(
+ AutoscalingConfig.AutoscalingTargets.newBuilder()
+ .setHighPriorityCpuUtilizationPercent(65)
+ .setStorageUtilizationPercent(95))
+ .build();
+ Instance instance =
+ Instance.newBuilder()
+ .setAutoscalingConfig(autoscalingConfig)
+ .setDisplayName(displayName)
+ .setConfig(
+ InstanceConfigName.of(projectId, configId).toString())
+ .build();
- // Create an InstanceInfo object that will be used to create the instance.
- InstanceInfo instanceInfo =
- InstanceInfo.newBuilder(InstanceId.of(projectId, instanceId))
- .setInstanceConfigId(InstanceConfigId.of(projectId, configId))
- .setAutoscalingConfig(autoscalingConfig)
- .setDisplayName("Descriptive name")
- .build();
- OperationFuture