Debian Codegraph @

doc/README.fbsvcmgr

raw
1 New utility fbsvcmgr in firebird 2.1.
2
3 Firebird (like interbase 6 and before) never had a way to access service from command line.
4 With the exception of -service switch of gbak and total use of services API in gsec since FB2,
5 to use services one had to use third party GUI or write himself a program using C or other
6 programming language. Use of GUI is almost always not a problem, when you work with local machine
7 or machine in your LAN. But in case, when you connect to remote unix server using any text-only
8 connection, use of services is almost impossible. And this is really a problem sometimes.
9
10 Utility fbsvcmgr solves this problem. With it you may use any service, implemented by firebird.
11 To use this utility you should be familiar with firebird services API - fbsvcmgr does NOT emulate
12 traditional utilities switches, this is just frontend with services API. The first required
13 parameter of command line is services manager you want to connect to. For local connection use
14 simply service_mgr, to attach to remote machine something like hostname:service_mgr is OK. Later
15 service parameter blocks (SPB) with values, when required, follow. Any of them may (or may not)
16 be prefixed with single '-' sign. For long command lines, typical for fbsvcmgr, use of '-' makes
17 command line better human-readable. Compare, please:
18 # fbsvcmgr service_mgr user sysdba password masterke action_db_stats dbname employee sts_hdr_pages
19 and
20 # fbsvcmgr service_mgr -user sysdba -password masterke -action_db_stats -dbname employee -sts_hdr_pages
21
22 Syntax of service parameter blocks, understood by fbsvcmgr, almost exactly match with one you may
23 see in ibase.h include file or Borland InterBase 6.0 API documentation. To save typing and make
24 command line a bit shorter slightly abbreviated form is used. All SPB parameters have one of two
25 forms: isc_spb_VALUE or isc_VALUE1_svc_VALUE2. Accordingly in first case you should type simply
26 VALUE, and for the second - VALUE1_VALUE2. For example:
27 isc_spb_dbname => dbname
28 isc_action_svc_backup => action_backup
29 isc_spb_sec_username => sec_username
30 isc_info_svc_get_env_lock => info_get_env_lock
31 and so on. Exception is one you see in the sample above - isc_spb_user_name may be specified as
32 user_name and simply user.
33
34 Describing of all SPB parameters is not real for README or release notes - it's about 40 pages
35 in InterBase 6.0 beta documentation. Therefore here only known differences between that
36 documentation and real life are noticed.
37
38 1. Using fbsvcmgr you may perform single action (and get results of it's execution when available)
39 or get multiple information items from services manager. For example:
40 # fbsvcmgr service_mgr -user sysdba -password masterke -action_display_user
41 will list all users of local firebird server:
42 SYSDBA Sql Server Administrator 0 0
43 QA_USER1 0 0
44 QA_USER2 0 0
45 QA_USER3 0 0
46 QA_USER4 0 0
47 QA_USER5 0 0
48 GUEST 0 0
49 SHUT1 0 0
50 SHUT2 0 0
51 QATEST 0 0
52 And:
53 # fbsvcmgr service_mgr -user sysdba -password masterke -info_server_version -info_implementation
54 will report both server version and it's implemenation:
55 Server version: LI-T2.1.0.15740 Firebird 2.1 Alpha 1
56 Server implementation: Firebird/linux AMD64
57 But attempt to mix all of this in single command line:
58 # fbsvcmgr service_mgr -user sysdba -password masterke -action_display_user -info_server_version -info_implementation
59 raises an error:
60 Unknown switch "-info_server_version"
61
62 2. Some parameters have buggy form in Borland beta documentation. When in trouble, consult ibase.h
63 first for correct form.
64
65 3. Everything concerning licensing was removed from interbase 6.0 and therefore not supported here.
66 Config file view/modification is not supported in firebird since 1.5 and therefore is not implemented
67 here.
68
69 4. isc_spb_rpr_list_limbo_trans was forgotten in Borland beta documentation, but present in fbsvcmgr.
70
71 5. Two new items, not mentioned by Borland beta documentation, were added to firebird 2.1 and are
72 supported by fbsvcmgr. One of them works only for windows, this is isc_spb_trusted_auth, which (type
73 as trusted_auth) forces use of windows trusted authentication by firebird. Another one is
74 availability to set (isc_spb_)dbname parameter in all security database related actions, it's an
75 equivalent of -database switch of gsec utility. Notice - in gsec this switch is mostly used to
76 specify remote server you want to administer. In fbsvcmgr name of server is already given in services
77 manager name (first parameter), therefore this parameter in most cases is not needed.
78
79 6. Items added in firebird 2.5:
80 - bkp_no_triggers - specify it to avoid executing database-wide triggers.
81
82 Author: Alex Peshkov, <peshkoff at mail.ru>