1 jim.wunderlich 1.1     Binary Repository readme
 2                        ========================
 3                    
 4                        Filename:  readme.binary_repository
 5                        Authors:   Karl Schopmeyer, Jim Wunderlich, 
 6                        Date:      20 April 2005	
 7                    
 8                          PEP 164 added the capability to write and read a repository in
 9                          binary mode as opposed to XML. The binary repository is approximately
10                          42% smaller than a regular xml text based repository. This allows
11                          significant disk space savings and also results in shorter file 
12                          load times. 
13                    
14                          The binary repository functionality supports both XML and binary 
15                          objects concurrently within the same repository. That is it supports
16                          mixed mode repositorys since the encoding and decoding is done on
17                          a per object basis.
18                    
19                    
20                        Building binary objects within the repository using Makefile (cimmofl)
21                        ======================================================================
22 jim.wunderlich 1.1 
23                          The  REPOSITORY_MODE environement variable controls whether
24                          new repository objects are written in XML or Binary mode by
25                          the makefiles using cimmofl. It can be set to XML or BIN and 
26                          defaults to XML.
27                    
28                    
29                    	1. Set REPOSITORY_MODE to BIN
30                    
31                                     export PEGASUS_REPOSITORY_MODE=BIN	(Unix)
32                    		 set PEGASUS_REPOSITORY_MODE=BIN        (Windows)
33                     
34                    
35                    	2. Build the repository 
36                    
37                                    make repository
38                    
39                    
40                    
41                        Building binary objects within the repository using Maekfile (cimmof)
42                        =====================================================================
43 jim.wunderlich 1.1 
44                          The enableBinaryRepository configuration variable controls
45                          whether new repository objects are written in XML or Binary
46                          mode when the server is running (cimmof).
47                    
48                    	1. Use the cimconfig utility to set the enableBinaryRepository
49                               flag to true in the planed configuration file as follows.
50                    
51                                     cimconfig -ps enableBinaryRepository=true 
52                    
53                    	2. Start the cimserver
54                    
55                    		cimserver start
56                    
57                    	3. Build the repository 
58                    
59                                    make repositoryServer
60                    
61                    
62                        Building binary objects within the repository using cimmofl
63                        ===========================================================
64 jim.wunderlich 1.1       The cimmofl command accepts a command line argument, 
65                          REPOSITORY_MODE (-M), that controls whether new repository 
66                          objects are written in XML (XML) or Binary (BIN) mode.
67                    
68                    	1. cimmofl -M BIN .......
69                    
70                    
71                    
72                    ======================================================================
73                    
74                    For additional information refer to PEP16 and to the help information 
75                    available from the following commands.
76                    
77                    
78                    	cimmofl -h
79                    	cimconfig -h
80