Update NEWS WRT pz:max_connections
[pazpar2-moved-to-github.git] / NEWS
1 Default value of setting pz:max_connections is 0 which means that there
2 is no limit on number of connections.
3
4 --- 1.4.0 2010/03/29
5
6 Pazpar2 may operate in threaded mode. Enabled by element threads in
7 the configuration. See pazpar2_conf for details.
8
9 New setting setting: pz:max_connections. Setting pz:max_connections is
10 a limit of number of sockets to a host. When this limit is reached,
11 Pazpar2 will wait up to 5 seconds for a connection to becomes available.
12 The client will be marked Client_Error when it can not be searched
13 (other clients in a session may work). If pz:max_connections is not set
14 for a target, a value of 30 will be used. Note: the pz:max_connections
15 will only work in threaded mode.
16
17 pz2.js: JSON support for show.
18
19 Debian package: Enable default service, default.xml, before starting
20 Pazpar2 only if there is no service already in /etc/pazpar2/services-enabled.
21
22 --- 1.3.0 2010/01/25
23
24 Debian version depends on on libyaz4. Note that Pazpar2 will still
25 compile from source with YAZ 3.
26
27 Split services into separate files. The example configuration file
28 pazpar2.cfg.dist now includes a default service default.xml (part of
29 etc). And default.xml includes settings/edu.xml. The default.xml file,
30 not to be confused with settings/defaults.xml, is a template for jsdemo
31 and other services. The Debian package installs /etc/pazpar2/server.xml
32 which is now the main pazpar2 configuration (used to be called pazpar2.cfg).
33 server.xml includes services from /etc/pazpar2/services-enabled/*.xml .
34 The default.xml (from etc) is installed in /etc/pazpar2/services-available
35 and a symlink to it is created from services-enabled. The default.xml
36 service is unnamed and, thus, will be used by jsdemo and test1.
37
38 New setting pz:negotiation_charset. Patch from Andrei V. Toutoukine. The
39 new setting pz:negotiation_charset specifies character set for Z39.50 Init.  
40
41 --- 1.2.4 2010/01/15
42
43 Support for additional fields in cf.xsl and pazpar2.conf.dist:
44 publisher, available, due, location (=locallocation), callno
45 (=callnumber), thumburl and score.
46
47 Describe pz:xslt and the auto setting.
48
49 Move mergekey definition away from the normalization stylesheets and
50 define a mergekey common for all target types in pazpar2.cfg.
51
52 Code update: Use the Odr_int type for hit counts. This is part of
53 YAZ 3.0.47 and later and so configure checks for that.
54
55 --- 1.2.3 2009/11/24
56
57 Metadata attribute 'skiparticle' also works for ICU based
58 normalization. (was only working for the non-ICU/ASCII before).
59
60 Command bytarget with argument settings=1 will show settings per
61 target.. This is to be able to verify correct settings and be able to
62 test that they are correct. The database settings array size is now
63 also stored..  Problems with database settings array is that if not
64 careful it will be too small (smaller than dictionary per-service
65 in settings).
66
67 Make record list sorting stable by comparing mergekey for records if
68 relevance/title or other sorting criteria all match. This is merely to
69 ensure that our regressions tests works (reproducible output).
70
71 Relevance calculation changes: use a different denominator (length) for
72 per-field relevance scoring.. Instead of length of all ranked fields we
73 now use length of individual fields (as if they were individual "free"
74 text fields). This will ensure that documents with a long field with no
75 match (say description) will not "hurt" a title match.
76
77 Diagnostic member was not set on connection error. Fixed
78
79 --- 1.2.2 2009/10/13
80
81 Command search takes two optional parameters, startecs and maxrecs,
82 that specifies the start offset (0, 1, ...) and maximum number of records
83 to fetch for each target.
84
85 XSLTs + MARC maps are cached within a session so we don't re-parse
86 them over and over again. Even for a session with a single search
87 there's much to be gained because many targets use the same
88 transformation.
89
90 The metadata attribute 'mergekey' now takes one of three values 'no',
91 'required', 'optional' .  And the resulting mergekey from metadata
92 is now ordered in the same way as metadata in the service definition.
93 Older Pazpar2 version use the order in which metadata appeared in a
94 record instance.
95
96 The search argument 'filter' now offers a new operator ~ which does a 
97 substring match. The = operator works as before: string match for
98 anything but pz:id, or target match for pz:id.
99
100 New setting pz:recordfilter. The value of this setting takes the
101 form name[~value]. This setting makes Pazpar2 ignore all retrieved
102 records that do not have the metadata element name with value substring
103 (if given).
104
105 Pazpar2 allows YAZ log level to be set (option -v).
106
107 --- 1.2.1 2009/10/05
108
109 For WS responses Pazpar2 creates XML header. Exception: raw record.
110
111 Setting XML files are now stored in etc/settings instead of etc. This
112 reflects the layout with the Debian package layout.
113
114 Settings may be posted for command=settings. The POSTed settings must
115 have root element 'settings' like regular setting files. In order to be
116 recognized, the POST request must use Content-Type=text/xml.
117
118 A service may be posted for command=init. This service will be used
119 during the session. The service may have its own target settings,
120 ICU config, timeout, etc. In order to be recognized, the POST request
121 must use Content-Type=text/xml.
122
123 Timeout values may be given per-service. That's element 'timeout' 
124 which takes three attribute values (a subset may be given): 'session',
125 'z3950_operation', 'z3950_session'. Option -T is no longer supported
126 - used to specify session timeout.
127
128 Option -t tests the Pazpar2 configuration and returns exit code
129 (0=success, non-zero=failure). In previous version of Pazpar2, -t
130 specified local settings.
131
132 In version 1.2.0 the configuration file - after include processing -
133 was dumped to stdout. Now, the configuration is only dumped to the
134 yaz log file if option -d is given.
135
136 --- 1.2.0 2009/09/10
137
138 Configuration may now have multiple server areas. This means that a
139 Pazpar2 instance may listen on multiple ports. Virtual hosting is not
140 yet supported - on a server basis. Configuration may also have multiple
141 services .. That is repeating service elements inside a server. Each
142 has an attribute 'id' which serves as service ID. This ID in turn may
143 be used in a Pazpar2 session, by specifying parameter service=ID for
144 command init. There can be at most one unnamed service inside a server
145 which can be referred to by not specifying an service ID for command
146 init (backwards compatible). In order to partition multiple servers and
147 services a new include directive has been added. This takes an attribute
148 'src' which specifies one or more sub-files. For example to include
149 service files, one might use:
150   <server >.. <include src=/"etc/pazpar2/conf.d/*.xml"/> .. </server>.
151 It is the intention that that completely makes the settings directive
152 redundant.
153
154 Fix problem where the record command would wait forever if there were
155 no targets to wait for (activeclients == 0).
156
157 --- 1.1.1 2009/08/28
158
159 One result set is created per session (last search) rather than for
160 each connection which happen to be shared (bug #3009).
161
162 marc21 stylesheets changed for efficiency.
163
164 --- 1.1.0 2009/08/19
165
166 Session timeout may be specified on the command-line as option -T.
167
168 Pazpar2 may now be operated in a no-merged mode for records.. All records
169 will be considered unique. This mode is enabled if no mergekey is
170 generated by the normalization stylesheet (pz:xslt). 
171
172 Pazpar2 caches original records from each target and the 'record' command
173 with offset returns the original record if 'syntax' and 'esn' are NOT
174 specified. This speeds up retrieval of original records but also means
175 that Pazpar2 uses more memory. The cached records will be freed when the
176 session terminates or a new search is executed.
177
178 Pazpar2 no longer uses its own ICU wrapper. Instead the ICU wrapper
179 library part of YAZ is used.
180
181 Added SRU client support.
182
183 Automatically computes pz:nativesyntax if not provided. Works for XML and
184 MARC.
185
186 --- 1.0.13 2008/11/24
187
188 Command bytarget returns name of target (if defined).
189
190 --- 1.0.12 2008/11/04
191
192 Fixed bug #2021.. location now holds all brief elements.
193
194 --- 1.0.11 2008/10/15
195
196 Fixed check for application/x-www-form-urlencoded parameters.
197
198 --- 1.0.10 2008/10/14
199
200 Fixes for IE in pz2.js.
201
202 Fixed bug #2021: non-merged, brief meta data NOT included for command=show.
203
204 --- 1.0.9 2008/05/23
205
206 Changed the JS library pz2.js to use POST for long URL (+ params).
207
208 Added installation instructions for Windows. Note: NT services is
209 NOT available until we make a new release of YAZ.
210
211 Preserve order of repeated metadata fields (they were reversed before).
212
213 More MARC21 information extracted for metadata.
214
215 --- 1.0.8 2008/04/22
216
217 Fixed bug #1162: HTML entities are not escaped properly.
218
219 Native Windows port of Pazpar2. Makefile for Visual Studio provided.
220
221 --- 1.0.7 2008/04/14
222
223 Marc21 stylesheet updated to reflect multiple full text fields
224
225 --- 1.0.6 2008/03/12
226
227 Fixed bug in pz2.js WRT DOMElement attributes on IE.
228
229 Fixed bug 2100: Database wildcards not working
230
231 --- 1.0.5 2007/11/09
232
233 Added support for retrieval of records in binary.
234
235 Fixed bug 1794: Pazpar2 does not return valid XML.
236
237 Deal with ICU not returning sortkey (resulted in SEGV before).
238
239 --- 1.0.4 2007/09/28
240
241 JavaScript library pzw2.js throws error if WS response (from Pazpar2 or
242 other) is malformed (non-wellformed XML or missing Pazpar2 OK status).
243
244 Improved diagnostics when Pazpar2 HTTP decoding fails.
245
246 Pazpar2 requests may be POSTed as using Content-Type
247 application/x-www-form-urlencoded.
248
249 Pazpar2 honors LF in HTTP headers.
250
251 Handle targets that handle negative hit counts (should not happen, but it
252 does).
253
254 --- 1.0.3 2007/09/19
255
256 ICU is used for tokenization and normalization of the following: mergekey,
257 sorting, relevance terms.
258
259 Debian package now enables ICU tokenization and normalization by default.
260
261 --- 1.0.2 2007/08/22
262
263 Exposed user setting values (i.e. non-pz: names) to the record systems in two
264 ways: Either as parameters to the normalization stylesheets (which would allow the
265 programmer to postprocess or use the values in any way) or after the normalization
266 step, in which case values are made part of the normalized record (and available for
267 sorting, termlists, display, or other interface-related use.
268
269 Implemented sorting by year.
270
271 Option -d dumps records to the current log file instead of stderr.
272
273 Fixes for compilation on cygwin.
274
275 Z39.50 client code uses pz:elements. pz:elements was recognized in
276 earlier Pazpar2 versions but it was not used for anything.
277
278 icu_chain_test is using fgets instead of getline - fixes compilation
279 on MacOSX .
280
281 Loosen the CCL query parsing so that Pazpar2 only returns error if _all_
282 query conversions fail (rather than _any_). This means targets that do
283 not support some fields are ignored in a search.
284
285 --- 1.0.1 2007/07/03
286
287 Improved handling of socket timeout for Z39.50 connections. 
288
289 Misc documentation updates and spell fixes.
290
291 Debian package pazpar2 creates log rotate entry.
292
293 Debian package pazpar2-apache2 reloads Apache2.
294
295 jsdemo included in distribution. It illustrates the use of the js/pz2.js
296 JavaScript library.
297
298 --- 1.0.0 2007/06/20
299
300 First public release.
301