Class: Google::Cloud::AlloyDB::V1beta::ExecuteSqlMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/alloydb/v1beta/service.rb

Overview

Any additional metadata information regarding the execution of the SQL

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Instance Attribute Details

#message ⇒ ::String

Returns Message related to SQL execution. Marked as core content since it can potentially contain details related to the query or result set. This field can be used to convey messages such as "when the SQL result set exceeds the acceptable response size limits.".

Returns:

  • (::String) —

    Message related to SQL execution. Marked as core content since it can potentially contain details related to the query or result set. This field can be used to convey messages such as "when the SQL result set exceeds the acceptable response size limits."



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'proto_docs/google/cloud/alloydb/v1beta/service.rb', line 1012

class ExecuteSqlMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status contains all valid Status a SQL execution can end up in.
  module Status
    # The status is unknown.
    STATUS_UNSPECIFIED = 0

    # No error during SQL execution i.e. All SQL statements ran to completion.
    # The "message" will be empty.
    OK = 1

    # Same as OK, except indicates that only partial results were
    # returned. The "message" field will contain details on why results were
    # truncated.
    PARTIAL = 2

    # Error during SQL execution. Atleast 1 SQL statement execution resulted in
    # a error. Side effects of other statements are rolled back.  The "message"
    # field will contain human readable error given by Postgres of the first
    # bad SQL statement. SQL execution errors don't constitute API errors as
    # defined in https://google.aip.dev/193 but will be returned as part of
    # this message.
    ERROR = 3
  end
end

#partial_result ⇒ ::Boolean

Returns Set to true if SQL returned a result set larger than the acceptable response size limits and the result was truncated.

Returns:

  • (::Boolean) —

    Set to true if SQL returned a result set larger than the acceptable response size limits and the result was truncated.



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'proto_docs/google/cloud/alloydb/v1beta/service.rb', line 1012

class ExecuteSqlMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status contains all valid Status a SQL execution can end up in.
  module Status
    # The status is unknown.
    STATUS_UNSPECIFIED = 0

    # No error during SQL execution i.e. All SQL statements ran to completion.
    # The "message" will be empty.
    OK = 1

    # Same as OK, except indicates that only partial results were
    # returned. The "message" field will contain details on why results were
    # truncated.
    PARTIAL = 2

    # Error during SQL execution. Atleast 1 SQL statement execution resulted in
    # a error. Side effects of other statements are rolled back.  The "message"
    # field will contain human readable error given by Postgres of the first
    # bad SQL statement. SQL execution errors don't constitute API errors as
    # defined in https://google.aip.dev/193 but will be returned as part of
    # this message.
    ERROR = 3
  end
end

#sql_statement_execution_duration ⇒ ::Google::Protobuf::Duration

Returns The time duration taken to execute the sql statement.

Returns:



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'proto_docs/google/cloud/alloydb/v1beta/service.rb', line 1012

class ExecuteSqlMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status contains all valid Status a SQL execution can end up in.
  module Status
    # The status is unknown.
    STATUS_UNSPECIFIED = 0

    # No error during SQL execution i.e. All SQL statements ran to completion.
    # The "message" will be empty.
    OK = 1

    # Same as OK, except indicates that only partial results were
    # returned. The "message" field will contain details on why results were
    # truncated.
    PARTIAL = 2

    # Error during SQL execution. Atleast 1 SQL statement execution resulted in
    # a error. Side effects of other statements are rolled back.  The "message"
    # field will contain human readable error given by Postgres of the first
    # bad SQL statement. SQL execution errors don't constitute API errors as
    # defined in https://google.aip.dev/193 but will be returned as part of
    # this message.
    ERROR = 3
  end
end

#status ⇒ ::Google::Cloud::AlloyDB::V1beta::ExecuteSqlMetadata::Status

Returns Status of SQL execution.

Returns:



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'proto_docs/google/cloud/alloydb/v1beta/service.rb', line 1012

class ExecuteSqlMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status contains all valid Status a SQL execution can end up in.
  module Status
    # The status is unknown.
    STATUS_UNSPECIFIED = 0

    # No error during SQL execution i.e. All SQL statements ran to completion.
    # The "message" will be empty.
    OK = 1

    # Same as OK, except indicates that only partial results were
    # returned. The "message" field will contain details on why results were
    # truncated.
    PARTIAL = 2

    # Error during SQL execution. Atleast 1 SQL statement execution resulted in
    # a error. Side effects of other statements are rolled back.  The "message"
    # field will contain human readable error given by Postgres of the first
    # bad SQL statement. SQL execution errors don't constitute API errors as
    # defined in https://google.aip.dev/193 but will be returned as part of
    # this message.
    ERROR = 3
  end
end