Skip to content

Spanner should have helpful aliases for param types #3364

Closed
Closed
Spanner should have helpful aliases for param types#3364
Assignees
tseaver
Labels
api: spannerIssues related to the Spanner API.type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.

Description

@theacodes
theacodes
opened on May 3, 2017

Having to do:

from google.cloud import spanner
from google.cloud.proto.spanner.v1 import type_pb2

instance = spanner_client.instance(instance_id)
database = instance.database(database_id)

params = {
    'start': start,
    'end': end
}
param_types = {
    'start': type_pb2.Type(code=type_pb2.STRING),
    'end': type_pb2.Type(code=type_pb2.STRING)
}
results = database.execute_sql(
    "SELECT AlbumId, AlbumTitle, MarketingBudget "
    "FROM Albums@{FORCE_INDEX=AlbumsByAlbumTitle} "
    "WHERE AlbumTitle >= @start AND AlbumTitle < @end",
    params=params, param_types=param_types)

Is rather awkward, it would be much more friendly to have:

from google.cloud import spanner

instance = spanner_client.instance(instance_id)
database = instance.database(database_id)

params = {
    'start': start,
    'end': end
}
param_types = {
    'start': spanner.ParamTypes.STRING,
    'end': spanner.ParamTypes.STRING
}
results = database.execute_sql(
    "SELECT AlbumId, AlbumTitle, MarketingBudget "
    "FROM Albums@{FORCE_INDEX=AlbumsByAlbumTitle} "
    "WHERE AlbumTitle >= @start AND AlbumTitle < @end",
    params=params, param_types=param_types)

or similar

Activity

  1. theacodes
    added
    api: spannerIssues related to the Spanner API.
    on May 3, 2017
  2. tseaver
    added
    type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.
    on May 16, 2017

  3. tseaver commented on Jul 25, 2017

    @tseaver
    tseaver
    on Jul 25, 2017
    Contributor

    @jonparrott Aliasing the "scalar" types is easy (PR #3670). What do you envision for array / struct?

  4. theacodes commented on Jul 25, 2017

    @theacodes
    theacodes
    on Jul 25, 2017
    ContributorAuthor

    @tseaver would list and dict work, e.g.:

    param_types = {
     tags: list,
     metadata: dict
}

  5. theacodes commented on Jul 25, 2017

    @theacodes
    theacodes
    on Jul 25, 2017
    ContributorAuthor

    Oh nevermind, ignore my last comment, I'm being thick.

    What does it look like today to if you need to specify an array / struct?

  6. tseaver
    added a commit that references this issue on Jul 27, 2017

    Create parameter type aliases for scalar field types. (#3670)

    a1269a6

  7. tseaver commented on Jul 27, 2017

    @tseaver
    tseaver
    on Jul 27, 2017
    Contributor

    @jonparrott For arrays, you have to pass the type of the elements:

    array_type = type_pb2.Type(
    code=type_pb2.ARRAY, array_element_type=type_pb2.Type(code=type_pb2.INT64))

    For structs, you have to construct / pass a StructType describing the members:

    struct_type_pb = type_pb2.StructType(fields=[
    type_pb2.StructType.Field(name='name', type=type_pb2.Type(code=type_pb2.STRING)),
    type_pb2.StructType.Field(name='age', type=type_pb2.Type(code=type_pb2.INT64)),
])
my_struct_type = type_pb2.Type(code=type_pb2.STRUCT, struct_type=struct_type_pb)

  8. theacodes commented on Jul 28, 2017

    @theacodes
    theacodes
    on Jul 28, 2017
    ContributorAuthor

    @tseaver that's pretty rough. Is it possible to make it into something like:

    from google.cloud.spanner import types

array_type = types.Array(types.INT64)
    struct_type = types.Struct(
    types.StructField('name', types.STRING),
    types.StructField('age', types.INT64)),
)

  9. tseaver commented on Jul 28, 2017

    @tseaver
    tseaver
    on Jul 28, 2017
    Contributor

    @jonparrott Assuming you meant to have the open square bracket after types.Struct (the order matters) that should be straightforward.

  10. theacodes commented on Jul 28, 2017

    @theacodes
    theacodes
    on Jul 28, 2017
    ContributorAuthor

    Actually I didn't, I meant for types.Struct to just use *args. But yeah, let's do it. :)

  11. tseaver commented on Jul 28, 2017

    @tseaver
    tseaver
    on Jul 28, 2017
    Contributor

    @jonparrott Should we name those factories ArrayParamType / StructParamType (to be equivalent to the FOO_PARAM_TYPE aliases?

  12. theacodes commented on Jul 28, 2017

    @theacodes
    theacodes
    on Jul 28, 2017
    ContributorAuthor

    Sure, if that's all they're used for.

  13. tseaver commented on Jul 28, 2017

    @tseaver
    tseaver
    on Jul 28, 2017
    Contributor

    Conceptually they describe types of returned cell values, too, but we don't expose that.

  14. tseaver
    closed this as completedin #3700on Jul 28, 2017
  15. tseaver
    added a commit that references this issue on Jul 28, 2017

    Add factories to ease creation of array / struct parameter types. (#3700

    78e51d9
  16. landrito
    added 6 commits that reference this issue on Aug 21, 2017

    Create parameter type aliases for scalar field types. (googleapis#3670)

    b356f88

    Add factories to ease creation of array / struct parameter types. (go…

    ae1f655

    Create parameter type aliases for scalar field types. (googleapis#3670)

    20688e0

    Add factories to ease creation of array / struct parameter types. (go…

    d34d30f

    Create parameter type aliases for scalar field types. (googleapis#3670)

    6de5f0a

    Add factories to ease creation of array / struct parameter types. (go…

    3ccb0b5
  17. JustinBeckwith
    assigned
    tseaver
    on Feb 1, 2021
  18. parthea
    added 2 commits that reference this issue on Mar 9, 2026

    Create parameter type aliases for scalar field types. (#3670)

    2018c8d

    Add factories to ease creation of array / struct parameter types. (#3700

    3e96c83
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

api: spannerIssues related to the Spanner API.type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions