firebird-mirror/src/jrd/btr_proto.h

/*
 *	PROGRAM:	JRD Access Method
 *	MODULE:		btr_proto.h
 *	DESCRIPTION:	Prototype header file for btr.cpp
 *
 * The contents of this file are subject to the Interbase Public
 * License Version 1.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy
 * of the License at http://www.Inprise.com/IPL.html
 *
 * Software distributed under the License is distributed on an
 * "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express
 * or implied. See the License for the specific language governing
 * rights and limitations under the License.
 *
 * The Original Code was created by Inprise Corporation
 * and its predecessors. Portions created by Inprise Corporation are
 * Copyright (C) Inprise Corporation.
 *
 * All Rights Reserved.
 * Contributor(s): ______________________________________.
 */

#ifndef _JRD_BTR_PROTO_H_
#define _JRD_BTR_PROTO_H_

#include "../jrd/btr.h"
#include "../jrd/ods.h"
#include "../jrd/req.h"

USHORT	BTR_all(TDBB, jrd_rel*, idx**, idx**, str**, SLONG*);
void	BTR_create(TDBB, jrd_rel*, idx*, USHORT, scb*, SelectivityList&);
void	BTR_delete_index(TDBB, win*, USHORT);
//USHORT	BTR_delete_node(TDBB, btree_page*, USHORT);
bool	BTR_description(jrd_rel*, irt*, idx*, SSHORT);
void	BTR_evaluate(tdbb*, irb*, sbm**);
UCHAR*	BTR_find_leaf(btree_page*, key*, UCHAR*, USHORT*, int, bool);
btree_page*	BTR_find_page(tdbb*, irb*, win*, idx*, key*, key*, bool);
void	BTR_insert(tdbb*, win*, iib*);
enum idx_e	BTR_key(tdbb*, jrd_rel*, rec*, idx*, key*, idx_null_state*);
USHORT	BTR_key_length(jrd_rel*, idx*);
UCHAR*	BTR_last_node(btree_page*, jrd_exp*, struct btx**);
btree_page*	BTR_left_handoff(tdbb*, win*, btree_page*, SSHORT);
USHORT	BTR_lookup(TDBB, jrd_rel*, USHORT, idx*);
void	BTR_make_key(tdbb*, USHORT, jrd_nod**, idx*, key*, USHORT);
bool	BTR_next_index(TDBB, jrd_rel*, jrd_tra*, idx*, win*);
void	BTR_remove(tdbb*, win*, iib*);
void	BTR_reserve_slot(TDBB, jrd_rel*, jrd_tra*, idx*);
void	BTR_selectivity(TDBB, jrd_rel*, USHORT, SelectivityList&);

#endif // JRD_BTR_PROTO_H
First steps towards a C++ conversion. 2001-05-23 15:26:42 +02:00			`/*`
			`* PROGRAM: JRD Access Method`
			`* MODULE: btr_proto.h`
const correctness, variables in scope, cleanup, etc. 2003-11-07 09:06:35 +01:00			`* DESCRIPTION: Prototype header file for btr.cpp`
First steps towards a C++ conversion. 2001-05-23 15:26:42 +02:00			`*`
			`* The contents of this file are subject to the Interbase Public`
			`* License Version 1.0 (the "License"); you may not use this file`
			`* except in compliance with the License. You may obtain a copy`
			`* of the License at http://www.Inprise.com/IPL.html`
			`*`
			`* Software distributed under the License is distributed on an`
			`* "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express`
			`* or implied. See the License for the specific language governing`
			`* rights and limitations under the License.`
			`*`
			`* The Original Code was created by Inprise Corporation`
			`* and its predecessors. Portions created by Inprise Corporation are`
			`* Copyright (C) Inprise Corporation.`
			`*`
			`* All Rights Reserved.`
			`* Contributor(s): ______________________________________.`
			`*/`

Enhanced Index Structure. 1) NULLs on top when sorting on ASC index, DESC stays the same. 2) Support for larger index lengths, can be up to 1/4 page size. 3) Store record-number on non-leafpages for faster lookup in many duplicates. 4) Jump-nodes for faster key-lookup in index on larger page-sizes. 5) Segment selectivity calculation added. 2003-12-01 03:37:25 +01:00			`#ifndef _JRD_BTR_PROTO_H_`
			`#define _JRD_BTR_PROTO_H_`
First steps towards a C++ conversion. 2001-05-23 15:26:42 +02:00
			`#include "../jrd/btr.h"`
			`#include "../jrd/ods.h"`
			`#include "../jrd/req.h"`

'struct' cleanup 2003-10-20 12:53:52 +02:00			`USHORT BTR_all(TDBB, jrd_rel, idx, idx, str, SLONG);`
Let's support segment-level selectivities. Amen. 2003-11-30 22:14:30 +01:00			`void BTR_create(TDBB, jrd_rel, idx, USHORT, scb*, SelectivityList&);`
'struct' cleanup 2003-10-20 12:53:52 +02:00			`void BTR_delete_index(TDBB, win*, USHORT);`
Cleanup 2004-02-02 12:02:12 +01:00			`//USHORT BTR_delete_node(TDBB, btree_page*, USHORT);`
Cleanup: const correctness BOOLEAN -> bool Vars in scope Formatting JRD_REQ -> jrd_req* JRD_TRA -> jrd_tra* JRD_REL -> jrd_rel* JRD_FLD -> jrd_fld* event -> event_t, EVENT_T dropped, EVENT should go in the future Frank's corrections alice's STR -> alice_str* remote's STR -> rem_str* etc. It creates entities and backups and restores for me. :-) 2004-01-03 11:59:52 +01:00			`bool BTR_description(jrd_rel, irt, idx*, SSHORT);`
'struct' cleanup 2003-10-20 12:53:52 +02:00			`void BTR_evaluate(tdbb, irb, sbm**);`
Cleanup 2004-02-02 12:02:12 +01:00			`UCHAR* BTR_find_leaf(btree_page, key, UCHAR, USHORT, int, bool);`
			`btree_page* BTR_find_page(tdbb, irb, win, idx, key, key, bool);`
'struct' cleanup 2003-10-20 12:53:52 +02:00			`void BTR_insert(tdbb, win, iib*);`
			`enum idx_e BTR_key(tdbb, jrd_rel, rec, idx, key, idx_null_state);`
			`USHORT BTR_key_length(jrd_rel, idx);`
Cleanup 2004-02-02 12:02:12 +01:00			`UCHAR* BTR_last_node(btree_page, jrd_exp, struct btx**);`
			`btree_page* BTR_left_handoff(tdbb, win, btree_page*, SSHORT);`
'struct' cleanup 2003-10-20 12:53:52 +02:00			`USHORT BTR_lookup(TDBB, jrd_rel, USHORT, idx);`
			`void BTR_make_key(tdbb, USHORT, jrd_nod, idx, key*, USHORT);`
			`bool BTR_next_index(TDBB, jrd_rel, jrd_tra, idx, win);`
			`void BTR_remove(tdbb, win, iib*);`
			`void BTR_reserve_slot(TDBB, jrd_rel, jrd_tra, idx*);`
Let's support segment-level selectivities. Amen. 2003-11-30 22:14:30 +01:00			`void BTR_selectivity(TDBB, jrd_rel*, USHORT, SelectivityList&);`
First steps towards a C++ conversion. 2001-05-23 15:26:42 +02:00
extern cleaning removing underscores in macros DLL_EXPORT cleaning 2003-10-03 03:34:14 +02:00			`#endif // JRD_BTR_PROTO_H`
Cleanup 2004-02-02 12:02:12 +01:00