home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-2.iso / Unix / database / msql.1.0.7.README < prev    next >
Encoding:
Text File  |  1995-11-21  |  6.0 KB  |  157 lines
  1. README for mSQL version 1.0 Patch 6    29 May 1995
  2. ----------------------------------------------------------------------------
  3.  
  4.  
  5. General Info
  6. ------------
  7.  
  8. mSQL has been developed under Sun OS 4.1.1 but has been tested under
  9. Solaris 2.3, Ultrix 4.3, Linux, and OSF/1 (cc not gcc).  That said, it 
  10. should "autoconf" and build on most BSD derived systems, SVR4 based 
  11. systems or POSIX O/S's (that should cover most of them).  It has been
  12. reported that it works out-of-the-box on HP-UX, NeXT, SCO, Sequent,
  13. Cray, Tandem and a few others.  I haven't tested these so buyer beware.
  14.  
  15.  
  16. Shareware
  17. ---------
  18.  
  19. mSQL has been released in the past under terms known as "conscience-ware",
  20. the basic concept of which was that companies that used the software
  21. could contribute a small ammount to the continued development of the
  22. software without any strict rules being placed upon such "donations".
  23. Although the concept sounds fair, it failed badly with only 3 contributions
  24. being made from over 3,600 copies of mSQL-1.0.5 that were ftp'ed from my
  25. machine alone.  Over 1,000 of those copies went to commercial organisations
  26. and I receive many questions a day from companies using mSQL behind
  27. their WWW servers etc who are looking for free support.
  28.  
  29. In an attempt to balance this out and allow me to devote some time to
  30. mSQL (rather than other persuits that I do to generate an income), mSQL
  31. is now shareware.  I still believe in free software over the Internet
  32. and cooperation in research so the new license is designed not to hurt
  33. Universities, research groups and other people that _should_ have free
  34. access to software.  Commercial organisations that are using this so
  35. that they don't have to buy an Oracle or an Ingres will now have to buy
  36. mSQL (at a minute fraction of the cost of one of the commercial
  37. offerings).
  38.  
  39. Please read the doc/License file to see if you are required to register
  40. your copy.  An invoice is included in both Postscript and ASCII format
  41. to ease the generation of payments.
  42.  
  43.  
  44. Installation
  45. ------------
  46.  
  47. To build mSQL, type "make target" in the top directory.  This will build
  48. a directory where the object files for your system will be made.  This
  49. mechanism allows you to NFS mount the sources onto different machines
  50. and build mSQL on different platforms without having to make copies of 
  51. the sources.  The directory will be under the "targets" directory (e.g.
  52. $(TOP)/targets/Solaris-2.3-Sparc )
  53.  
  54. Once the target directory has been created, change directory into it and
  55. run "setup".  That will run autoconf and some other configuration
  56. scripts.  Some system wide configuraion items, including the language
  57. for error moessages, are defined in common/site.h so you should probably
  58. have a look at that file and change anything you feel needs to be
  59. changed.
  60.  
  61. Once you've done that, just type make.  You should install the software 
  62. with "make install" when you're happy with it.  
  63.  
  64. The default installation directory is /usr/local/Minerva.  This area is
  65. shared by all the development of Minerva (including the ESL scripting
  66. language and Minerva itself).  It's probably a good idea to leave it as
  67. that rather than /usr/local/msql or similar if you wish to use ESL
  68. (check out doc/Minerva for details on ESL or grab the ESL manual via ftp
  69. from Bond.edu.au in /pub/Minerva/esl )
  70.  
  71.  
  72. Testing the software
  73. --------------------
  74.  
  75. Once it is installed, you can try the sample mSQL script provided in
  76. the msql source directory.  Fire up the server using
  77.  
  78.     /usr/local/Minerva/bin/msqld&
  79.  
  80. Create a test database using
  81.  
  82.     /usr/local/Minerva/bin/msqladmin create test
  83.  
  84. Run the script through the terminal monitor using
  85.  
  86.     /usr/local/Minerva/bin/msql test < sample.msql
  87.  
  88. There are also some further test scripts in the tests directory.  The
  89. "killer" test will produce performance figures about mSQL running on
  90. your machine.  Details such as the number of operations per second for
  91. inserts, fills and selects on both keyed and flat tables is generated.
  92.  
  93. The most complete test is the regressions test found in test/rtest.  Run
  94. it using 'rtest DBname' where dbname is the name of a database it can
  95. trash.
  96.  
  97.  
  98. Notes :
  99.     o  Because this stuff is pretty new, there's a script in the
  100.     scripts directory that you may want to use to run the server.  It
  101.     restarts the server if it crashes and mails you a notification
  102.     of the failure.  It's called run_daemon and may save you some 
  103.     heart ache.
  104.  
  105.     o  If you run this on a Cray (what?  you don't have a Y-MP at
  106.     home? :) you'll have to remove -lsocket and -lx from EXTRA_LIB 
  107.     in site.mm after you run setup.
  108.  
  109.     o If you are building this with gcc and see link errors like
  110.     __load.o(.text+0x1a): undefined reference to `mcount'
  111.     edit site.mm and set 'CC=gcc -static'
  112.  
  113.  
  114.  
  115.  
  116. Further Doco
  117. ------------
  118.  
  119. A set of WWW pages for mSQL are now available in the Fiddich
  120. Technologies are of Web Publishing Australia.  The URL is
  121.  
  122.     http://AusWeb.com.au/computer/Fiddich
  123.  
  124.  
  125.  
  126. Bugs / Problems
  127. ---------------
  128.  
  129. If you find what you think is a bug or you have a problem or question
  130. you'd like answered, __please__ join the mailing list and ask your
  131. question there.  My mailbox floweth over.  I am continually getting
  132. messages to my private mailbox regarding old problems and other matters 
  133. that have been discussed many times on the mailing list.  It takes a lot
  134. of time to wade through the 100's of message I receive per week.
  135.  
  136. You can join the mailing list by sending a message containing just the
  137. word "subscribe" to 
  138.  
  139.     msql-list-request@Bond.edu.au.
  140.  
  141. If you want to report a bug, please include the following :-
  142.  
  143.     Include the output of "msqladmin version"
  144.     Include a dump of a test database using msqldump
  145.     Include a mSQL script that will show the bug
  146.  
  147. You should also ensure that you are running the latest (stable) version
  148. of mSQL before mailing the list as I fix bugs in every version.
  149.  
  150.  
  151.  
  152.    __                                  David J. Hughes  -  Bambi@Bond.edu.au
  153.   /  \               /  /   /           http://Bond.edu.au/People/bambi
  154.  /___/ __   _   ____/  /   / _     
  155. /   \ /  \ / \ /   /  /   / / \  /   Senior Network Programmer, Bond University
  156. \___/ \__//  / \__/   \__/ /  / /    Qld.   4229   AUSTRALIA    (+61 75 951450)
  157.