Class: TeradataCli::SuccessStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/teradata-cli/connection.rb

Constant Summary collapse

ACTIVITY_ECHO =
33

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(stmt_no, act_cnt, warn_code, n_fields, act_type, warning) ⇒ SuccessStatus

Returns a new instance of SuccessStatus.



452
453
454
455
456
457
458
459
# File 'lib/teradata-cli/connection.rb', line 452

def initialize(stmt_no, act_cnt, warn_code, n_fields, act_type, warning)
  @statement_no = stmt_no
  @activity_count = act_cnt
  @warning_code = warn_code
  @num_fields = n_fields
  @activity_type = act_type
  @warning = warning
end

Instance Attribute Details

#acitivity_typeObject (readonly)

Returns the value of attribute acitivity_type.



463
464
465
# File 'lib/teradata-cli/connection.rb', line 463

def acitivity_type
  @acitivity_type
end

#activity_countObject (readonly)

Returns the value of attribute activity_count.



462
463
464
# File 'lib/teradata-cli/connection.rb', line 462

def activity_count
  @activity_count
end

#n_fieldsObject (readonly)

Returns the value of attribute n_fields.



464
465
466
# File 'lib/teradata-cli/connection.rb', line 464

def n_fields
  @n_fields
end

#statement_noObject (readonly)

Returns the value of attribute statement_no.



461
462
463
# File 'lib/teradata-cli/connection.rb', line 461

def statement_no
  @statement_no
end

#warningObject (readonly)

Returns the value of attribute warning.



466
467
468
# File 'lib/teradata-cli/connection.rb', line 466

def warning
  @warning
end

#warning_codeObject (readonly)

Returns the value of attribute warning_code.



465
466
467
# File 'lib/teradata-cli/connection.rb', line 465

def warning_code
  @warning_code
end

Class Method Details

.parse(parcel_data) ⇒ Object



446
447
448
449
450
# File 'lib/teradata-cli/connection.rb', line 446

def SuccessStatus.parse(parcel_data)
  stmt_no, _, act_cnt, warn_code, n_fields, act_type, warn_len  = parcel_data.unpack('CCLSSSS')
  warning = parcel_data[13, warn_len]
  new(stmt_no, act_cnt, warn_code, n_fields, act_type, warning)
end

Instance Method Details

#echo?Boolean

Returns:

  • (Boolean)


505
506
507
# File 'lib/teradata-cli/connection.rb', line 505

def echo?
  @activity_type == ACTIVITY_ECHO
end

#error?Boolean

Returns:

  • (Boolean)


492
493
494
# File 'lib/teradata-cli/connection.rb', line 492

def error?
  false
end

#error_codeObject



472
473
474
# File 'lib/teradata-cli/connection.rb', line 472

def error_code
  0
end

#failure?Boolean

Returns:

  • (Boolean)


488
489
490
# File 'lib/teradata-cli/connection.rb', line 488

def failure?
  false
end

#infoObject



476
477
478
# File 'lib/teradata-cli/connection.rb', line 476

def info
  nil
end

#inspectObject



468
469
470
# File 'lib/teradata-cli/connection.rb', line 468

def inspect
  "\#<Success \##{@statement_no} cnt=#{@activity_count}>"
end

#messageObject



480
481
482
# File 'lib/teradata-cli/connection.rb', line 480

def message
  ''
end

#succeeded?Boolean

Returns:

  • (Boolean)


484
485
486
# File 'lib/teradata-cli/connection.rb', line 484

def succeeded?
  true
end

#valueObject



496
497
# File 'lib/teradata-cli/connection.rb', line 496

def value
end

#warned?Boolean

Returns:

  • (Boolean)


499
500
501
# File 'lib/teradata-cli/connection.rb', line 499

def warned?
  @warning_code != 0
end