Administration Tools - ooexportfd

Printer-friendly version
Creates an XML document representing an entire federated database, including its data, schema, and catalog information.
ooexportfd
    [-entireschema]
    [-outfile filename [-maxfilesize value][-compress]
        [-exists ask | delete | quit]]
    [-nws]
    [-shortnames]
    [-verbose]
    [-standardmaps]
    [-stoponerror]
    [-schemalock lockVal]
    [-standalone]
    [-notitle]
    [-quiet]
    [-help]
    bootFilePath
Options
 
    
-entireschema
Generates XML elements for all classes in the federated database’s schema, including Objectivity/DB internal classes. You can omit this option to generate XML elements only for application-defined classes, producing a smaller XML document.
You can normally omit this option because the destination federated database of an import operation already contains the schema for Objectivity/DB internal classes. You should specify -entireschema if the federated database being exported was created with a different release of Objectivity/DB than the intended destination federated database.
    
-outfile filename
Base name for all output files. You may optionally include a path to an existing directory in which to create the output files; if you do not include a path, the output files are created in the directory in which you ran the tool.
You can omit this option to send the generated XML document to stdout.
Specifying this option creates the following output files:
One or more files containing the XML document. The first or only such file is called filename.xml; subsequent files are numbered sequentially, starting with filename_2.xml. Multiple files are generated only to keep the file size within the limit specified by -maxfilesize.
A report file called filenameReport.xml summarizing the number of XML elements of each kind in the XML document.
A file called filenameInstall.xml showing file locations and other information stored in the exported catalog. This install file serves as a template for specifying nondefault file locations and other configuration information when the catalog is imported into another federated database.
    
-maxfilesize value
Maximum size of each output file, expressed as an integer number of megabytes (MB). You can omit this option to set the maximum size to 100 MB.
This option applies only when the -outfile option is also specified.
    
-compress
Compresses the output files using a built-in gzip utility. When you specify this option, each output file has the additional extension .gz—for example, filename.xml.gz
This option applies only when the -outfile option is also specified.
    
-exists
Action to take if a file already exists with the same name as a generated output file.
ask    Prompts whether to overwrite the existing file. If the answer is No, the program terminates. No is the default.
delete    Deletes any existing file.
quit    Terminates the program if the file currently exists.
The default value is ask.
This option applies only when the -outfile option is also specified.
    
-nws
Suppresses all nonessential "white space" (spaces, tabs, and blank lines), producing an XML document that is more compact, but less readable.
You can omit this option to format each XML tag on a separate line, indented to indicate its level of nesting.
    
-shortnames
Shortens all XML tag names and attribute names, producing an XML document that is more compact, but less readable. Each shortened name is usually a single character and is not necessarily mnemonic—for example:
<l i="7/>.
You can omit this option to generate XML tags and attributes with longer, more mnemonic names—for example: <Basic value="7/>.
    
-verbose
Expands various XML elements to include additional detail, producing an XML document that is more readable, but less compact. You can omit this option to generate XML elements that contain only the minimum information required by ooimport.
For example, a verbose XML element for a persistent object includes the name and type number of the object’s class. In contrast, the corresponding nonverbose version includes just the type number, which is sufficient for identifying the object’s class to ooimport.
    
-standardmaps
Simplifies the XML representation of name maps (instances of ooMap or OoMap), producing a more compact and readable XML document. You may specify this option only if all of the name maps to be exported use the default hashing function.
Warning: Do not specify -standardmaps if the name maps to be exported use an application-defined hashing function. Doing so will produce an XML representation of the name maps that cannot be reconstructed by ooimport; such name maps will be unusable after they have been imported.
Omitting this option causes the XML representation of name maps to more closely correspond to their comparatively complex internal structure.
When specified, this option causes name maps to be represented using just two types of XML element (<Map> and <MapElement>).
    
-stoponerror
Terminates immediately when an error is detected.
Omitting this option causes the tool to report errors to stderr and continue processing. Each reported error contains an XPath expression for the node being processed at the time of the error, followed by an explanatory message.
    
-schemalock lockVal
64-bit unsigned integer key for unlocking the schema for this export operation. You can normally omit this option because, by default, the schema is not locked. This option is required only if you have explicitly locked the schema of a federated database using Objectivity/DB Active Schema.
    
-standalone    
Nonconcurrent mode. Use this option if no lock server is running or to bypass a running lock server.
Warning: Corruption can occur if concurrent access to the federated database is attempted while any process is using this mode.
    
-notitle    
Suppresses the copyright notice and program title banner. Useful when invoking the tool from another tool or product.
    
-quiet    
Suppresses all normal program output.
    
-help    
Prints the tool syntax and definition to the screen.
    
bootFilePath    
Path to the boot file of the federated database to be exported. You can omit this argument if you set the OO_FD_BOOT environment variable to the correct path. (HA) You can specify the boot file of any autonomous partition.
Discussion
 
This tool exports an entire federated database by representing it textually in Extensible Markup Language (XML). More specifically, this tool creates an XML document containing a hierarchy of XML elements representing the objects, schema, and catalog that comprise the federated database. You can specify this XML document to the ooimport tool to transfer the exported elements into a destination federated database—for example, to reproduce an entire federated database in a different location or with a different storage-page size.
By default, this tool exports schema descriptions only of application-defined classes. You can use the -entireschema option to export the entire schema.
You can control the size and readability of the XML document with the -nws, -shortnames, -verbose, -entireschema, and -standardmaps options.
By default, the XML document is sent to stdout. You can save this document to one or more files by specifying the -outfile option. This option also generates a summary report of the XML elements present in the XML document, along with an install file (a template for changing catalog information upon import). You control the size of the output files with the -maxfilesize and -compress options.
Note:
This tool exports external containers such that they can be recreated as external containers by ooimport.
oodump. However, note that oodump does not preserve external containers, but rather, exports them as embedded containers.
See also
 
Date: 
Tuesday, October 30, 2012
Product: 
Objectivity/DB
Version: 
10.2.1
10.2
10.1.4
10.1.2
9.4.1