Class: IBRuby::Backup

Inherits:
Object
  • Object
show all
Defined in:
lib/src.rb

Overview

This class represents a service manager task to backup an existing database on the InterBase server. NOTE: This class does not currently work on the Mac OS X platform.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(database, file) ⇒ Backup

This is the constructor for the Backup class.

Parameters

database

A String or File giving the path and name (relative to the database server) of the main database file for the database to be backed up.

file

A String or File giving the path and name (relative to the database server) of the back up file to be generated.



1402
1403
 
# File 'lib/src.rb', line 1402

def initialize(database, file)
end

Instance Attribute Details

#backup_file ⇒ Object

Attribute accessor.



1387
1388
1389
 
# File 'lib/src.rb', line 1387

def backup_file
  @backup_file
end

#database ⇒ Object

Attribute accessor.



1387
1388
1389
 
# File 'lib/src.rb', line 1387

def database
  @database
end

Instance Method Details

#blocking_factor ⇒ Object

This method fetches the blocking factor to be used in generating the back up. This will return nil until it has been explicitly set.



1410
1411
 
# File 'lib/src.rb', line 1410

def blocking_factor
end

#blocking_factor=(size) ⇒ Object

This method sets the blocking factor to be used in generating the back up.

Parameters

size

A reference to an integer containing the new back up blocking factor setting.



1422
1423
 
# File 'lib/src.rb', line 1422

def blocking_factor=(size)
end

#convert_tables ⇒ Object

This method fetches the convert tables setting for a Backup object.



1519
1520
 
# File 'lib/src.rb', line 1519

def convert_tables
end

#convert_tables=(setting) ⇒ Object

This method is used to set the indicator for whether external tables will be converted to internal tables as part of the backup.

Parameters

setting

True to convert external tables, false otherwise.



1530
1531
 
# File 'lib/src.rb', line 1530

def convert_tables=(setting)
end

#execute(manager) ⇒ Object

This method is used to execute a backup task against a service manager.

Parameters

manager

A reference to the service manager to execute the backup task against.

Exceptions

IBRubyException

Generated whenever a disconnected service manager

is specified or a problem occurs executing the
task.



1546
1547
 
# File 'lib/src.rb', line 1546

def execute(manager)
end

#garbage_collect ⇒ Object

This method fetches the garbage collect setting for a Backup object.



1483
1484
 
# File 'lib/src.rb', line 1483

def garbage_collect
end

#garbage_collect=(setting) ⇒ Object

This method is used to set the indicator for whether the backup will undertake garbage collection.

Parameters

setting

True to perform garbage collection, false otherwise.



1494
1495
 
# File 'lib/src.rb', line 1494

def garbage_collect=(setting)
end

#ignore_checksums ⇒ Object

This method fetches the ignore checksums setting for a Backup object.



1429
1430
 
# File 'lib/src.rb', line 1429

def ignore_checksums
end

#ignore_checksums=(setting) ⇒ Object

This method is used to set the indicator for whether checksum values should be ignored in performing a backup.

Parameters

setting

True to ignore checksums, false otherwise.



1440
1441
 
# File 'lib/src.rb', line 1440

def ignore_checksums=(setting)
end

#ignore_limbo ⇒ Object

This method fetches the ignore limbo setting for a Backup object.



1447
1448
 
# File 'lib/src.rb', line 1447

def ignore_limbo
end

#ignore_limbo=(setting) ⇒ Object

This method is used to set the indicator for whether limbo transactions should be ignored in performing a backup.

Parameters

setting

True to ignore limbo transactions, false otherwise.



1458
1459
 
# File 'lib/src.rb', line 1458

def ignore_limbo=(setting)
end

#log ⇒ Object

This method fetches the log value for a Backup task. This value will always be nil until the task has been executed. After a successful execution the log value should contain output from the backup task generated on the server.



1556
1557
 
# File 'lib/src.rb', line 1556

def log
end

#metadata_only ⇒ Object

This method fetches the metadata only setting for a Backup object.



1465
1466
 
# File 'lib/src.rb', line 1465

def metadata_only
end

#metadata_only=(setting) ⇒ Object

This method is used to set the indicator for whether a backup stores only the database metadata.

Parameters

setting

True to store only metadata, false otherwise.



1476
1477
 
# File 'lib/src.rb', line 1476

def metadata_only=(setting)
end

#non_transportable ⇒ Object

This method fetches the non-transportable setting for a Backup object.



1501
1502
 
# File 'lib/src.rb', line 1501

def non_transportable
end

#non_transportable=(setting) ⇒ Object

This method is used to set the indicator for whether backup generated by the task will be platform specific.

Parameters

setting

True to generate a platform specific backup, false otherwise.



1512
1513
 
# File 'lib/src.rb', line 1512

def non_transportable=(setting)
end