File: tokyotyrant.idl

package info (click to toggle)
tokyotyrant 1.1.40-4.2
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch
  • size: 1,892 kB
  • ctags: 1,482
  • sloc: ansic: 15,331; sh: 427; makefile: 295; perl: 192; awk: 91; ruby: 42
file content (143 lines) | stat: -rw-r--r-- 5,283 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/*************************************************************************************************
 * IDL for bindings of scripting languages
 *                                                      Copyright (C) 2006-2009 Mikio Hirabayashi
 * This file is part of Tokyo Tyrant.
 * Tokyo Tyrant is free software; you can redistribute it and/or modify it under the terms of
 * the GNU Lesser General Public License as published by the Free Software Foundation; either
 * version 2.1 of the License or any later version.  Tokyo Tyrant is distributed in the hope
 * that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 * You should have received a copy of the GNU Lesser General Public License along with Tokyo
 * Tyrant; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307 USA.
 *************************************************************************************************/


/**
 * namespace of Tokyo Tyrant
 */
module TokyoTyrant {
  //----------------------------------------------------------------
  // list of strings (substituted for by the native mechanism)
  //----------------------------------------------------------------
  interface List {
    string get(in long index);
  };
  //----------------------------------------------------------------
  // map of strings (substituted for by the native mechanism)
  //----------------------------------------------------------------
  interface Map {
    string get(in string key);
  };
  //----------------------------------------------------------------
  // the error codes
  //----------------------------------------------------------------
  interface ECODE {
    const long ESUCCESS = 0;
    const long EINVALID = 1;
    const long ENOHOST = 2;
    const long EREFUSED = 3;
    const long ESEND = 4;
    const long ERECV = 5;
    const long EKEEP = 6;
    const long ENOREC = 7;
    const long EMISC = 9999;
    long ecode();
    string errmsg(in long ecode);
  };
  //----------------------------------------------------------------
  // the remove database API
  //----------------------------------------------------------------
  interface RDB :ECODE {
    const long XOLCKREC = 1 << 0;
    const long XOLCKGLB = 1 << 1;
    const long MONOULOG = 1 << 0;
    boolean open(in string host, in long port);
    boolean close();
    boolean put(in string key, in string value);
    boolean putkeep(in string key, in string value);
    boolean putcat(in string key, in string value);
    boolean putshl(in string key, in string value, in long width);
    boolean putnr(in string key, in string value);
    boolean out(in string key);
    string get(in string key);
    long mget(inout Map recs);
    long vsiz(in string key);
    boolean iterinit();
    string iternext();
    List fwmkeys(in string prefix, in long max);
    long addint(in string key, in long num);
    double adddouble(in string key, in double num);
    string ext(in string name, in string key, in string value, in long opts);
    boolean sync();
    boolean optimize(in string params);
    boolean vanish();
    boolean copy(in string path);
    long long rnum();
    long long size();
    string stat();
    List misc(in string name, in List args, in long opts);
  };
  //----------------------------------------------------------------
  // the table extension API
  //----------------------------------------------------------------
  interface RDBTBL :RDB {
    const long ITLEXICAL = 0;
    const long ITDECIMAL = 1;
    const long ITTOKEN = 2;
    const long ITQGRAM = 3;
    const long ITOPT = 9998;
    const long ITVOID = 9999;
    const long ITKEEP = 1 << 24;
    boolean put(in string pkey, in Map cols);
    boolean putkeep(in string pkey, in Map cols);
    boolean putcat(in string pkey, in Map cols);
    boolean out(in string pkey);
    Map get(in string pkey);
    boolean setindex(in string name, in long type);
    long long genuid();
  };
  interface RDBQRY {
    const long QCSTREQ = 0;
    const long QCSTRINC = 1;
    const long QCSTRBW = 2;
    const long QCSTREW = 3;
    const long QCSTRAND = 4;
    const long QCSTROR = 5;
    const long QCSTROREQ = 6;
    const long QCSTRRX = 7;
    const long QCNUMEQ = 8;
    const long QCNUMGT = 9;
    const long QCNUMGE = 10;
    const long QCNUMLT = 11;
    const long QCNUMLE = 12;
    const long QCNUMBT = 13;
    const long QCNUMOREQ = 14;
    const long QCFTSPH = 15;
    const long QCFTSAND = 16;
    const long QCFTSOR = 17;
    const long QCFTSEX = 18;
    const long QCNEGATE = 1 << 24;
    const long QCNOIDX = 1 << 25;
    const long QOSTRASC = 0;
    const long QOSTRDESC = 1;
    const long QONUMASC = 2;
    const long QONUMDESC = 3;
    const long MSUNION = 0;
    const long MSISECT = 1;
    const long MSDIFF = 2;
    void addcond(in string name, in long op, in string expr);
    void setorder(in string name, in long type);
    void setlimit(in long max, in long skip);
    List search();
    boolean searchout();
    string hint();
    typedef sequence<RDBQRY> QueryList;
    List metasearch(in QueryList qrys, in long type);
  };
};



/* END OF FILE */