Skip to content

feat(spanner): support for type UUID #2235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
alkatrivedi wants to merge 1 commit into from
+458 −4
Closed

feat(spanner): support for type UUID #2235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/codec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import {Big} from 'big.js';
import {common as p} from 'protobufjs';
import {google as spannerClient} from '../protos/protos';
import {GoogleError} from 'google-gax';
import * as uuid from 'uuid';

// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type Value = any;
Expand Down Expand Up @@ -1034,6 +1035,7 @@ const TypeCode: {
bool: 'BOOL',
int64: 'INT64',
pgOid: 'INT64',
uuid: 'UUID',
float32: 'FLOAT32',
float64: 'FLOAT64',
numeric: 'NUMERIC',
Expand Down Expand Up @@ -1075,6 +1077,7 @@ interface FieldType extends Type {
/**
* @typedef {object} ParamType
* @property {string} type The param type. Must be one of the following:
* - uuid
* - float32
* - float64
* - int64
Expand Down Expand Up @@ -1157,6 +1160,10 @@ function getType(value: Value): Type {
return {type: 'bool'};
}

if (uuid.validate(value)) {
return {type: 'unspecified'};
Copy link
Contributor

@sakthivelmanii sakthivelmanii Feb 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why unspecified here?

Copy link
Contributor Author

@alkatrivedi alkatrivedi Feb 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cause we are not sure if the customer has inserted the UUID value in the column of type UUID/String. Hence, we are returning type as unspecified implicitly, but while making gRPC call we are making sure that if the type is unspecified we don't pass param type with the gaxOptions, this way are letting backend to figure out the type

Copy link
Contributor

@surbhigarg92 surbhigarg92 Feb 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sakthivelmanii uuid value can be send for String column as well. So we want to make use of "unspecified" type and let backend decide it.
Ideally we should not have removed the type mapping when backend started suplorting untyped params, but we did not remove this because of breaking changes.

Copy link
Contributor

@harshachinta harshachinta Feb 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But will this work for parameterized queries. I think parameterized queries does not support UNSPECIFIED type.
@alkatrivedi can you check if parameterized query is working when passing a UUID value?

Copy link
Contributor

@harshachinta harshachinta Feb 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The case that we are talking about here is when customer triggers a following parameterized query without an explicit param type
const query = {
sql: 'SELECT @v',
params: {
v: values,
},
};
I think this fails if value is of UUID type and param type is not mentioned because client now sends a UNSPECIFIED type to backend

Copy link
Contributor

@harshachinta harshachinta Feb 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My suggestion here is
Ideally, if param type is not mentioned then treat the value as string.
If customer wants to treat that value as UUID then they can explicitly specify the param type.

Copy link
Contributor Author

@alkatrivedi alkatrivedi Feb 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

based on the discussion with @harshachinta and @surbhigarg92

we will return the type as unspecified, allowing the backend to determine the type of the value provided

regarding the query - 'SELECT @v'

failure in this case, where the parameter type is not inferred, is expected behavior. since the query does not target a specific table, deriving type dynamically is not a valid scenario

Copy link

@flovouin flovouin Jan 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Flash forward one year later, when this has been merged: it breaks usage of implicitly-string parameters containing a UUID, at least with the emulator.

They are detected as UUID by this line of code, and this results in a type-less struct type being passed to the backend, which it doesn't like. For example, the parameter user contains a UUID (the same query worked fine before UUID "support" was introduced):

Error: 3 INVALID_ARGUMENT: Type code must be specified, found ; 
    When parsing field #0 of code: STRUCT
    struct_type {
      fields {
        name: \"user\"
        type {
        }
      }
    }

My suggestion here is
Ideally, if param type is not mentioned then treat the value as string.
If customer wants to treat that value as UUID then they can explicitly specify the param type.

This seemed like a much more reasonable way of introducing a new feature and preserving backward compatibility.

I'll open an issue when I have time, but I'd highly appreciate proactive effort from the team to fix this, as the issue had been identified during the review process and was ignored.

Copy link
Contributor Author

@alkatrivedi alkatrivedi Jan 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@flovouin Thanks for flagging this! I will take a look

}

if (isString(value)) {
return {type: 'string'};
}
Expand Down
10 changes: 9 additions & 1 deletion src/transaction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1728,7 +1728,15 @@ export class Snapshot extends EventEmitter {
if (!isEmpty(typeMap)) {
Object.keys(typeMap).forEach(param => {
const type = typeMap[param];
paramTypes[param] = codec.createTypeObject(type);
const typeObject = codec.createTypeObject(type);
if (
(type.child &&
typeObject.code === 'ARRAY' &&
typeObject.arrayElementType?.code !== 'TYPE_CODE_UNSPECIFIED') ||
(!type.child && typeObject.code !== 'TYPE_CODE_UNSPECIFIED')
) {
paramTypes[param] = codec.createTypeObject(type);
}
});
}

Expand Down
Loading
Loading