File: function.yaz-search.html

package info (click to toggle)
php3 3%3A3.0.18-0potato1.1
  • links: PTS
  • area: main
  • in suites: potato
  • size: 17,736 kB
  • ctags: 11,198
  • sloc: ansic: 108,120; sh: 2,512; php: 2,024; yacc: 1,887; makefile: 1,038; perl: 537; pascal: 238; awk: 90; cpp: 28; sql: 11
file content (431 lines) | stat: -rw-r--r-- 6,244 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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
<HTML
><HEAD
><TITLE
>yaz_search</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="YAZ functions"
HREF="ref.yaz.html"><LINK
REL="PREVIOUS"
TITLE="yaz_record"
HREF="function.yaz-record.html"><LINK
REL="NEXT"
TITLE="yaz_syntax"
HREF="function.yaz-syntax.html"><META
NAME="HTTP_EQUIV"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.yaz-record.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.yaz-syntax.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.yaz-search"
>yaz_search</A
></H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN40646"
></A
><P
>    (PHP4 &#62;= 4.0.1)</P
>yaz_search&nbsp;--&nbsp;Prepares for a search</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN40649"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><A
NAME="AEN40651"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <B
CLASS="function"
>yaz_search</B
></CODE
> (int id, string type, string query)</CODE
></P
><P
></P
></DIV
><P
>&#13;     <B
CLASS="function"
>yaz_search()</B
> prepares for a search on the
     target with given id. The type represents the query type - only
     "rpn" is supported now in which case the third argument specifies
     a Type-1 query (RPN). Like <A
HREF="function.yaz-connect.html"
><B
CLASS="function"
>yaz_connect()</B
></A
> this
     function is non-blocking and only prepares for a search to be
     executed later when <A
HREF="function.yaz-wait.html"
><B
CLASS="function"
>yaz_wait()</B
></A
> is called.
    </P
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN40665"
></A
><H2
>The RPN query</H2
><P
>&#13;     The RPN query is a textual represenation of the Type-1 query as
     defined by the Z39.50 standard. However, in the text representation
     as used by YAZ a prefix notation is used, that is the operater
     precedes the operands. The query string is a sequence of tokens where
     white space is ignored is ignored unless surrounded by double
     quotes. Tokens beginning with an at-character (<TT
CLASS="literal"
>@</TT
>)
     are considered operators, otherwise they are treated as search terms.
    </P
><DIV
CLASS="table"
><A
NAME="AEN40669"
></A
><P
><B
>Table 1. RPN Operators</B
></P
><TABLE
BORDER="1"
CLASS="CALSTABLE"
><THEAD
><TR
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
>Syntax</TH
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
>Description</TH
></TR
></THEAD
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="literal"
>@and query1 query2</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>intersection of query1 and query2</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="literal"
>@or query1 query2</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>union of query1 and query2</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="literal"
>@not query1 query2</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>query1 and not query2</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="literal"
>@set name</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>result set reference</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="literal"
>@attrset set query</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>specifies attribute-set for query. This construction is only
                allowed once - in the beginning of the whole query</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="literal"
>@attr set type=value query</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>applies attribute to query. The type and value are
                 integers specifying the attribute-type and attribute-value
                 respectively. The set, if given, specifies the
                 attribute-set.</TD
></TR
></TBODY
></TABLE
></DIV
><P
>&#13;     The following illustrates valid query constructions:
     <DIV
CLASS="informalexample"
><A
NAME="AEN40702"
></A
><P
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="screen"
>computer</PRE
></TD
></TR
></TABLE
><P
></P
></DIV
>
      Matches documents where "computer" occur. No attributes are specified.
    </P
><P
>&#13;     <DIV
CLASS="informalexample"
><A
NAME="AEN40705"
></A
><P
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="screen"
>"donald knuth"</PRE
></TD
></TR
></TABLE
><P
></P
></DIV
>
     Matches documents where "donald knuth" occur.
    </P
><P
>&#13;     <DIV
CLASS="informalexample"
><A
NAME="AEN40708"
></A
><P
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="screen"
>@attr 1=4 art</PRE
></TD
></TR
></TABLE
><P
></P
></DIV
>
     Attribute type is 1 (Bib-1 use), attribute value is 4
     Title), so this should match documents where "art" occur
     in the title.
    </P
><P
>&#13;     <DIV
CLASS="informalexample"
><A
NAME="AEN40711"
></A
><P
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="screen"
>@attrset gils @and @attr 1=4 art @attr 1=1003 "donald knuth"</PRE
></TD
></TR
></TABLE
><P
></P
></DIV
>
     The query as a whole uses the GILS attributeset. The query matches
     documents where "art" occur in the title and in which "donald knuth"
     occur in the author.
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.yaz-record.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.yaz-syntax.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>yaz_record</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.yaz.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>yaz_syntax</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>