Class: FireRuby::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 Firebird 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.



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

def initialize(database, file)
end

Instance Attribute Details

#backup_file ⇒ Object

Attribute accessor.



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

def backup_file
  @backup_file
end

#database ⇒ Object

Attribute accessor.



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

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.



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

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.



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

def blocking_factor=(size)
end

#convert_tables ⇒ Object

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



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

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.



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

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

FireRubyException

Generated whenever a disconnected service manager is specified or a problem occurs executing the task.



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

def execute(manager)
end

#garbage_collect ⇒ Object

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



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

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.



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

def garbage_collect=(setting)
end

#ignore_checksums ⇒ Object

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



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

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.



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

def ignore_checksums=(setting)
end

#ignore_limbo ⇒ Object

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



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

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.



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

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.



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

def log
end

#metadata_only ⇒ Object

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



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

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.



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

def metadata_only=(setting)
end

#non_transportable ⇒ Object

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



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

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.



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

def non_transportable=(setting)
end