Class: Rubyfb::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.



1487
1488
 
# File 'lib/src.rb', line 1487

def initialize(database, file)
end

Instance Attribute Details

#backup_file ⇒ Object

Attribute accessor.



1472
1473
1474
 
# File 'lib/src.rb', line 1472

def backup_file
  @backup_file
end

#database ⇒ Object

Attribute accessor.



1472
1473
1474
 
# File 'lib/src.rb', line 1472

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.



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

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.



1507
1508
 
# File 'lib/src.rb', line 1507

def blocking_factor=(size)
end

#convert_tables ⇒ Object

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



1605
1606
 
# File 'lib/src.rb', line 1605

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.



1616
1617
 
# File 'lib/src.rb', line 1616

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.



1632
1633
 
# File 'lib/src.rb', line 1632

def execute(manager)
end

#garbage_collect ⇒ Object

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



1569
1570
 
# File 'lib/src.rb', line 1569

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.



1580
1581
 
# File 'lib/src.rb', line 1580

def garbage_collect=(setting)
end

#ignore_checksums ⇒ Object

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



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

def ignore_checksums
end

#ignore_checksums=(setting) ⇒ Object

Parameters

setting

True to ignore checksums, false otherwise.



1526
1527
 
# File 'lib/src.rb', line 1526

def ignore_checksums=(setting)
end

#ignore_limbo ⇒ Object

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



1533
1534
 
# File 'lib/src.rb', line 1533

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.



1544
1545
 
# File 'lib/src.rb', line 1544

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.



1642
1643
 
# File 'lib/src.rb', line 1642

def log
end

#metadata_only ⇒ Object

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



1551
1552
 
# File 'lib/src.rb', line 1551

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.



1562
1563
 
# File 'lib/src.rb', line 1562

def metadata_only=(setting)
end

#non_transportable ⇒ Object

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



1587
1588
 
# File 'lib/src.rb', line 1587

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.



1598
1599
 
# File 'lib/src.rb', line 1598

def non_transportable=(setting)
end