1 martin 1.3 //%LICENSE////////////////////////////////////////////////////////////////

  2 martin 1.4 //

  3 martin 1.3 // Licensed to The Open Group (TOG) under one or more contributor license
  4            // agreements.  Refer to the OpenPegasusNOTICE.txt file distributed with
  5            // this work for additional information regarding copyright ownership.
  6            // Each contributor licenses this file to you under the OpenPegasus Open
  7            // Source License; you may not use this file except in compliance with the
  8            // License.

  9 martin 1.4 //

 10 martin 1.3 // Permission is hereby granted, free of charge, to any person obtaining a
 11            // copy of this software and associated documentation files (the "Software"),
 12            // to deal in the Software without restriction, including without limitation
 13            // the rights to use, copy, modify, merge, publish, distribute, sublicense,
 14            // and/or sell copies of the Software, and to permit persons to whom the
 15            // Software is furnished to do so, subject to the following conditions:

 16 martin 1.4 //

 17 martin 1.3 // The above copyright notice and this permission notice shall be included
 18            // in all copies or substantial portions of the Software.

 19 martin 1.4 //

 20 martin 1.3 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

 21 martin 1.4 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

 22 martin 1.3 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 23            // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 24            // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 25            // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 26            // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

 27 martin 1.4 //

 28 martin 1.3 //////////////////////////////////////////////////////////////////////////

 29 jim.wunderlich 1.1     Binary Repository readme
 30                        ========================
 31                    
 32                        Filename:  readme.binary_repository

 33 kumpf          1.5     Authors:   Karl Schopmeyer, Jim Wunderlich,

 34 jim.wunderlich 1.1     Date:      20 April 2005	
 35                    
 36                          PEP 164 added the capability to write and read a repository in
 37                          binary mode as opposed to XML. The binary repository is approximately
 38                          42% smaller than a regular xml text based repository. This allows

 39 kumpf          1.5       significant disk space savings and also results in shorter file
 40                          load times.

 41 jim.wunderlich 1.1 

 42 kumpf          1.5       The binary repository functionality supports both XML and binary

 43 jim.wunderlich 1.1       objects concurrently within the same repository. That is it supports
 44                          mixed mode repositorys since the encoding and decoding is done on
 45                          a per object basis.
 46                    
 47                    
 48                        Building binary objects within the repository using Makefile (cimmofl)
 49                        ======================================================================
 50                    
 51                          The  REPOSITORY_MODE environement variable controls whether
 52                          new repository objects are written in XML or Binary mode by

 53 kumpf          1.5       the makefiles using cimmofl. It can be set to XML or BIN and

 54 jim.wunderlich 1.1       defaults to XML.
 55                    
 56                    
 57                    	1. Set REPOSITORY_MODE to BIN
 58                    
 59                                     export PEGASUS_REPOSITORY_MODE=BIN	(Unix)
 60                    		 set PEGASUS_REPOSITORY_MODE=BIN        (Windows)
 61                    

 62 kumpf          1.5 
 63                    	2. Build the repository

 64 jim.wunderlich 1.1 
 65                                    make repository
 66                    
 67                    
 68                    
 69                        Building binary objects within the repository using Maekfile (cimmof)
 70                        =====================================================================
 71                    
 72                          The enableBinaryRepository configuration variable controls
 73                          whether new repository objects are written in XML or Binary
 74                          mode when the server is running (cimmof).
 75                    
 76                    	1. Use the cimconfig utility to set the enableBinaryRepository
 77                               flag to true in the planed configuration file as follows.
 78                    

 79 kumpf          1.5                  cimconfig -ps enableBinaryRepository=true

 80 jim.wunderlich 1.1 
 81                    	2. Start the cimserver
 82                    
 83                    		cimserver start
 84                    

 85 kumpf          1.5 	3. Build the repository

 86 jim.wunderlich 1.1 
 87                                    make repositoryServer
 88                    
 89                    
 90                        Building binary objects within the repository using cimmofl
 91                        ===========================================================

 92 kumpf          1.5       The cimmofl command accepts a command line argument,
 93                          REPOSITORY_MODE (-M), that controls whether new repository

 94 jim.wunderlich 1.1       objects are written in XML (XML) or Binary (BIN) mode.
 95                    
 96                    	1. cimmofl -M BIN .......
 97                    
 98                    
 99                    
100                    ======================================================================
101                    

102 kumpf          1.5 For additional information refer to PEP16 and to the help information

103 jim.wunderlich 1.1 available from the following commands.
104                    
105                    
106                    	cimmofl -h
107                    	cimconfig -h

108 karl           1.2