backup.epp

/*
 *	PROGRAM:	JRD Backup and Restore Program
 *	MODULE:		backup.epp
 *	DESCRIPTION:	Backup routine
 *
 * 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): ______________________________________.
 *
 * Toni Martir: Added verbose backup records as BACKUP_VERBOSE_INTERVAL
 * 2001.07.06 Sean Leyne - Code Cleanup, removed "#ifdef READONLY_DATABASE"
 *                         conditionals, as the engine now fully supports
 *                         readonly databases.
 * 2001.11.20 Claudio Valderrama: fix problem with embedded blanks in
 * generators and use symbol_length effective length calculation from put_text.
 * This minimizes code redundancy and fixes SF Bug #483276.
 * 2001.12.15 Claudio Valderrama: copy should run through symbol_length instead
 * of using just another length calculation algorithm. Callers of put_text, copy
 * and symbol_length (if used directly) should use sizeof. Changed all callers
 * and sizeof() works because the strings are local to the functions. This
 * eliminates the problem with harcoded limits in each call.
 * 2002.10.29 Mike Nordell: UINT64 backup message.
 * 2003.08.17 Claudio Valderrama: Fix SF Bug #750659.
 * 2005.04.29 Claudio Valderrama: Moved symbol_length to misc.cpp.
 */


#include "firebird.h"
#include <stdio.h>
#include <memory.h>
#include <string.h>
#include "../burp/burp.h"
#include "../jrd/ods.h"
#include "../jrd/align.h"
#include "../common/gdsassert.h"
#include "../jrd/constants.h"
#include "../common/stuff.h"
#include "../burp/backu_proto.h"
#include "../burp/burp_proto.h"
#include "../burp/canon_proto.h"
#include "../burp/mvol_proto.h"
#include "../remote/protocol.h"
#ifdef DEBUG
#include "../common/prett_proto.h"
#endif

#include "../common/classes/BlobWrapper.h"
#include "../common/classes/MsgPrint.h"
#include "../burp/OdsDetection.h"
#include "../burp/BurpTasks.h"

using MsgFormat::SafeArg;
using namespace Firebird;
using namespace Burp;


// For service APIs the follow DB handle is a value stored
// in thread data.  This is also done for other statics generated by
// GPRE.  This is to avoid multiple threading problems with module
// level statics.

#define DB			tdgbl->db_handle
#define fbTrans		tdgbl->tr_handle
#define gds_trans	tdgbl->tr_handle
#define fbStatus	(&tdgbl->status_vector)
#define isc_status	(&tdgbl->status_vector)
#define gds_status	(&tdgbl->status_vector)

// unused
#define fbProvider
#define fbStatus2

DATABASE DB = STATIC FILENAME "yachts.lnk" RUNTIME * dbb_file;

namespace // unnamed, private
{

#define PUT_MESSAGE(attrib, attrib2, message) put_message((attrib), (attrib2), (message), sizeof(message))
#define PUT_TEXT(attribute, text)	put_text ((attribute), (text), sizeof(text))
#define COPY(source, target)       copy ((source), (target), sizeof(target))

inline void put(BurpGlobals* tdgbl, const UCHAR c)
{
	tdgbl->put(c);
}

inline void put(BurpGlobals* tdgbl, const att_type c)
{
	put(tdgbl, UCHAR(c));
}

inline const UCHAR* put_block(BurpGlobals* tdgbl, const UCHAR* p, ULONG n)
{
	return MVOL_write_block (tdgbl, p, n);
}


void compress(const UCHAR*, ULONG);
int copy(const TEXT*, TEXT*, ULONG);
burp_fld* get_fields(burp_rel*);
SINT64 get_gen_id(const QualifiedMetaString& name);
void get_ranges(burp_fld*);
void put_array(burp_fld*, burp_rel*, ISC_QUAD*);
void put_asciz(const att_type, const TEXT*);
void put_blob(burp_fld*, ISC_QUAD&);
bool put_blr_blob(att_type, ISC_QUAD&);
void put_data(burp_rel*, ReadRelationReq*);
void put_index(burp_rel*);
int put_message(att_type, att_type, const TEXT*, const ULONG);
void put_int32(att_type, SLONG);
void put_int64(att_type attribute, SINT64 value);
void put_boolean(att_type, FB_BOOLEAN value);
void put_relation(burp_rel*);
bool put_source_blob(att_type, att_type, ISC_QUAD&);
int put_text(att_type, const TEXT*, SSHORT);
int put_text(att_type attribute, const MetaString& name);
void write_character_sets();
void write_check_constraints();
void write_collations();
void write_database(const TEXT*);
void write_exceptions();
void write_field_dimensions();
void write_filters();
void write_functions();
void write_function_args(const QualifiedMetaString& name);
void write_global_fields();
void write_generators();
void write_sql_roles();
void write_mapping();
void write_db_creators();
void write_packages();
void write_procedures();
void write_procedure_prms(const QualifiedMetaString& name);
void write_publications();
void write_pub_tables();
void write_ref_constraints();
void write_rel_constraints();
void write_relations();
void write_schemas();
void write_secclasses();
void write_shadow_files();
void write_triggers();
void write_trigger_messages();
void write_types();
void write_user_privileges();
void write_constants();
void general_on_error();


#ifdef DEBUG
UCHAR debug_on = 0;		// able to turn this on in debug mode
#endif


constexpr UCHAR blob_items[] =
{
	isc_info_blob_max_segment,
	isc_info_blob_num_segments,
	isc_info_blob_type,
	isc_info_blob_total_length
};
constexpr UCHAR blr_items[] =
{
	isc_info_blob_max_segment,
	isc_info_blob_total_length
};
constexpr UCHAR source_items[] =
{
	isc_info_blob_max_segment,
	isc_info_blob_total_length,
	isc_info_blob_num_segments
};
constexpr UCHAR db_info_items[] =
{
	isc_info_db_sql_dialect,
	isc_info_page_size,
	isc_info_sweep_interval,
	isc_info_forced_writes,
	isc_info_no_reserve,
	isc_info_set_page_buffers,
	isc_info_db_read_only,
	fb_info_replica_mode,
	isc_info_end
};
constexpr UCHAR limbo_tpb[] =
{
	isc_tpb_version1,
	isc_tpb_ignore_limbo
};
constexpr UCHAR limbo_nau_tpb[] =
{
	isc_tpb_version1,
	isc_tpb_ignore_limbo,
	isc_tpb_no_auto_undo
};

} // namespace


int BACKUP_backup(const TEXT* dbb_file, const TEXT* file_name)
{
/**************************************
 *
 *	B A C K U P _ b a c k u p
 *
 **************************************
 *
 * Functional description
 *	Backup a database.
 *
 **************************************/
	FbLocalStatus status_vector;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	tdgbl->gbl_database_file_name = dbb_file;

	gds_trans = 0;

	BURP_verbose(130);
	// msg 130 starting transaction

	if (tdgbl->gbl_sw_ignore_limbo)
	{
		gds_trans = DB->startTransaction(&status_vector, sizeof(limbo_nau_tpb), limbo_nau_tpb);
		if (status_vector->getState() & Firebird::IStatus::STATE_ERRORS)
		{
			gds_trans = DB->startTransaction(&status_vector, sizeof(limbo_tpb), limbo_tpb);
		}
	}
	else
	{
		EXEC SQL SET TRANSACTION NO_AUTO_UNDO;
		if (isc_status->getState() & Firebird::IStatus::STATE_ERRORS)
			EXEC SQL SET TRANSACTION;
	}

	if (!gds_trans)
	{
		EXEC SQL SET TRANSACTION NAME gds_trans NO_AUTO_UNDO;
		if (isc_status->getState() & Firebird::IStatus::STATE_ERRORS)
			EXEC SQL SET TRANSACTION NAME gds_trans;
	}

	// get shared snapshot number if asked for parallel backup
	tdgbl->tr_snapshot = 0;
	if (gds_trans && tdgbl->gbl_sw_par_workers > 1)
	{
		UCHAR in_buf[] = {fb_info_tra_snapshot_number, isc_info_end};
		UCHAR out_buf[16] = {0};

		gds_trans->getInfo(fbStatus, sizeof(in_buf), in_buf, sizeof(out_buf), out_buf);
		if (fbStatus->isEmpty())
		{
			UCHAR* p = out_buf, *e = out_buf + sizeof(out_buf);
			while (p < e)
			{
				SSHORT len;
				switch (*p++)
				{
				case isc_info_error:
				case isc_info_end:
					p = e;
					break;

				case fb_info_tra_snapshot_number:
					len = isc_portable_integer(p, 2);
					p += 2;
					tdgbl->tr_snapshot = isc_portable_integer(p, len);
					p += len;
					break;
				}
			}
		}
		if (tdgbl->tr_snapshot == 0)
			tdgbl->gbl_sw_par_workers = 1;
	}

	// detect if MAKE_DBKEY is supported and decide kind of read relation query
	if (tdgbl->gbl_sw_par_workers > 1)
	{
		constexpr const char* sql = "SELECT MAKE_DBKEY(0, 0) FROM RDB$DATABASE";
		IStatement* stmt = DB->prepare(fbStatus, gds_trans, 0, sql, 3, 0);
		if (fbStatus->getState() & IStatus::RESULT_ERROR)
		{
			// BURP_print_status(isc_status);
			tdgbl->gbl_sw_par_workers = 1;
		}
		if (stmt)
			stmt->free(fbStatus);
	}

	if (tdgbl->gbl_sw_par_workers)
	{
		BURP_verbose(410, SafeArg() << tdgbl->gbl_sw_par_workers);
		// msg 410 use up to @1 parallel workers
	}

	// decide what type of database we've got

	detectRuntimeODS();
	if (tdgbl->runtimeODS < DB_VERSION_OLDEST_SUPPORTED)
	{
		BURP_error(348, true, SafeArg() << tdgbl->runtimeODS);
		// msg 348 database format @1 is too old to backup
	}

	// Write burp record first with other valuable information
	// In case of split operation, write a 'split' header first to all the files

	if (tdgbl->action->act_action == ACT_backup_split)
	{
		for (burp_fil* fil = tdgbl->gbl_sw_files; fil; fil = fil->fil_next)
		{
			tdgbl->action->act_file = fil;
			if (!MVOL_split_hdr_write())
			{
				BURP_error(269, true, tdgbl->action->act_file->fil_name.c_str());
				// msg 269 can't write a header record to file %s
			}
		}
		tdgbl->action->act_file = tdgbl->gbl_sw_files;
	}

	MVOL_init_write(file_name);

	// Write database record

	write_database(dbb_file);

	if (tdgbl->runtimeODS >= DB_VERSION_DDL14)
	{
		// Write schemas
		BURP_verbose(412);	// msg 412 writing schemas
		write_schemas();
	}

	// Write global fields

	BURP_verbose(150);
	// msg 150  writing global fields
	write_global_fields();

	write_field_dimensions();

	BURP_verbose(162);
	// msg 162  writing shadow files
	write_shadow_files();

	// Write Character Sets
	BURP_verbose(msgVerbose_write_charsets);
	write_character_sets();

	// Write Collations
	BURP_verbose(msgVerbose_write_collations);
	write_collations();

	// Write relations

	BURP_verbose(154);
	// msg 154 writing tables

	write_relations();

	// Write types
	BURP_verbose(161);
	// msg 161  writing types
	write_types();

	// Write filters
	BURP_verbose(146);
	// msg 146 writing filters
	write_filters();

	// Write generators
	BURP_verbose(164);
	// msg 164  writing id generators
	write_generators();

	// Write exceptions
	BURP_verbose(197);
	// msg 197 writing exceptions
	write_exceptions();

	// Write functions
	BURP_verbose(148);
	// msg 148 writing functions
	write_functions();

	// Write procedures
	BURP_verbose(192);
	// msg 192 writing stored procedures
	write_procedures();

	if (tdgbl->runtimeODS >= DB_VERSION_DDL12)
	{
		// Write packages
		BURP_verbose(336);	// msg 336 writing packages
		write_packages();
	}

	// Now go back and write all data

	{
	Coordinator coord(getDefaultMemoryPool());
	BackupRelationTask task(tdgbl);

	for (burp_rel* relation = tdgbl->relations; relation; relation = relation->rel_next)
	{
		put(tdgbl, (UCHAR) rec_relation_data);

		if (relation->rel_name.schema.hasData())
			put_text(att_relation_schema_name, relation->rel_name.schema);

		put_text(att_relation_name, relation->rel_name.object);

		put(tdgbl, att_end);

		if (!(relation->rel_flags & REL_view) && !(relation->rel_flags & REL_external))
		{
			put_index(relation);
			if (!(tdgbl->gbl_sw_meta || tdgbl->skipRelation(relation->rel_name)))
			{
				task.SetRelation(relation);
				coord.runSync(&task);

				if (!task.getResult(NULL))
					BURP_exit_local(FINI_ERROR, tdgbl);
			}
		}

		put(tdgbl, (UCHAR) rec_relation_end);
	}
	}

	// now for the new triggers in rdb$triggers
	BURP_verbose(159);
	// msg 159  writing triggers
	write_triggers();
	BURP_verbose(158);
	// msg 158 writing trigger messages
	write_trigger_messages();
	write_user_privileges();

	// Last, but not least, go back and add any access control lists

	BURP_verbose(347); // msg 347 writing security classes
	write_secclasses();

	// Write relation constraints
	BURP_verbose(206);
	// msg 206 writing relation constraints
	write_rel_constraints();

	// Write referential constraints
	BURP_verbose(209);
	// msg 209 writing referential constraints
	write_ref_constraints();

	// Write check constraints
	BURP_verbose(210);
	// msg 210 writing check constraints
	write_check_constraints();

	if (tdgbl->runtimeODS >= DB_VERSION_DDL9)
	{
		// Write SQL roles
		BURP_verbose(248);
		// msg 248 writing SQL roles
		write_sql_roles();
	}

	if (tdgbl->runtimeODS >= DB_VERSION_DDL11)
	{
		// Write names mapping
		BURP_verbose(296);
		// msg 296 writing mapping
		write_mapping();
	}

	if (tdgbl->runtimeODS >= DB_VERSION_DDL12)
	{
		// Write database creators
		write_db_creators();
	}

	if (tdgbl->runtimeODS >= DB_VERSION_DDL13)
	{
		// Write publications
		BURP_verbose(396);	// msg 396 writing publications

		write_publications();
		write_pub_tables();
	}

	if (tdgbl->runtimeODS >= DB_VERSION_DDL14)
	{
		// Write constants
		BURP_verbose(USHORT(isc_gbak_writing_constants));	// writing constants
		write_constants();
	}

	// Finish up

	put(tdgbl, (UCHAR) rec_end);
	FB_UINT64 cumul_count = MVOL_fini_write();
	tdgbl->action->act_action = ACT_backup_fini;
	BURP_verbose(176, SafeArg() << cumul_count);
	// msg 176 closing file, committing, and finishing.  %ld bytes written

	COMMIT;
	ON_ERROR
		general_on_error();
	END_ERROR;

	if (gds_trans)
		COMMIT gds_trans;
	ON_ERROR
		general_on_error();
	END_ERROR;

	if (tdgbl->gbl_stat_flags)
		BURP_verbose(369);
	// msg 369 total statistics

	FINISH
	ON_ERROR
		general_on_error();
	END_ERROR;

	return FINI_OK;
}

namespace // unnamed, private
{

void compress(const UCHAR* data, ULONG length)
{
/**************************************
 *
 *	c o m p r e s s
 *
 **************************************
 *
 * Functional description
 *	Write out data in compressed form.
 *
 **************************************/
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	const UCHAR* p = data;
	const UCHAR* end = p + length;
	const UCHAR* q = NULL;

	while (p < end)
	{
		for (q = p + 2; q < end && (q[-2] != q[-1] || q[-1] != q[0]); q++)
			;
		SLONG run = (q < end) ? q - p - 2 : end - p;
		if (run)
		{
			for (; run > 127; run -= 127)
			{
				USHORT len = 127;
				put(tdgbl, (UCHAR) len);
				p = put_block(tdgbl, p, len);
			}
			if (run)
			{
				put(tdgbl, (UCHAR) run);
				p = put_block(tdgbl, p, run);
			}
		}
		for (q = p; q < end && *q == *p; q++)
			;
		if ((run = q - p) != 0)
		{
			for (; run > 127; run -= 127)
			{
				put(tdgbl, (UCHAR) (-127));
				put(tdgbl, (UCHAR) (*p));
			}
			if (run)
			{
				put(tdgbl, (UCHAR) (-run));
				put(tdgbl, (UCHAR) (*p));
			}
			p = q;
		}
	}
}


int copy( const TEXT* from, TEXT* to, ULONG size_len)
{
/**************************************
 *
 *	c o p y
 *
 **************************************
 *
 * Functional description
 *	Copy a blank or null terminated string into a null terminated
 *	string. It assumes there's enough room in the target.
 *
 **************************************/

	const ULONG len = (ULONG) MISC_symbol_length(from, size_len);

	memcpy(to, from, len);
	to[len] = '\0';

	return (int) len;
}


void general_on_error()
{
/**************************************
 *
 *	g e n e r a l _ o n _ e r r o r
 *
 **************************************
 *
 * Functional description
 *	Handle any general ON_ERROR clause during backup.
 *
 **************************************/
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	BURP_abort(isc_status);
}


burp_fld* get_fields( burp_rel* relation)
{
/**************************************
 *
 *	g e t _ f i e l d s
 *
 **************************************
 *
 * Functional description
 *	Get fields for a relation.  Test
 *	capabilities and get system specific
 *
 **************************************/
	burp_fld* field;
	ISC_QUAD* blob_id;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	USHORT count = 1;

	Firebird::HalfStaticArray<burp_fld*, 16> field_list;

	// if we have all capabilities, use the first request to get the
	// most performance out of the latest engine; if we don't
	// have one of the capabilities we must use the second set of
	// requests--this requires more code but it is well worth it
	// for the performance benefits, especially remotely--deej

	if (tdgbl->runtimeODS >= DB_VERSION_DDL12)
	{
		FOR (REQUEST_HANDLE tdgbl->handles_get_fields_req_handle1)
			X IN RDB$RELATION_FIELDS CROSS
			Y IN RDB$FIELDS WITH
			X.RDB$FIELD_SOURCE_SCHEMA_NAME EQUIV Y.RDB$SCHEMA_NAME AND
			X.RDB$FIELD_SOURCE = Y.RDB$FIELD_NAME AND
			X.RDB$SCHEMA_NAME EQUIV NULLIF(relation->rel_name.schema.c_str(), '') AND
			X.RDB$RELATION_NAME EQ relation->rel_name.object.c_str()
		{
			field = (burp_fld*) BURP_alloc_zero(sizeof(burp_fld));
			field->fld_number = count++;
			field->fld_type = Y.RDB$FIELD_TYPE;
			field->fld_sub_type = Y.RDB$FIELD_SUB_TYPE;
			field->fld_length = Y.RDB$FIELD_LENGTH;
			field->fld_scale = Y.RDB$FIELD_SCALE;
			field->fld_id = X.RDB$FIELD_ID;

			if (!X.RDB$DESCRIPTION.NULL)
			{
				blob_id = &X.RDB$DESCRIPTION;
				if (blob_id->gds_quad_low || blob_id->gds_quad_high)
					field->fld_description = X.RDB$DESCRIPTION;
			}

			if (!X.RDB$QUERY_HEADER.NULL)
			{
				blob_id = &X.RDB$QUERY_HEADER;
				if (blob_id->gds_quad_low || blob_id->gds_quad_high)
					field->fld_query_header = X.RDB$QUERY_HEADER;
			}

			if (X.RDB$FIELD_POSITION.NULL)
				field->fld_flags |= FLD_position_missing;
			else
				field->fld_position = X.RDB$FIELD_POSITION;
			field->fld_view_context = X.RDB$VIEW_CONTEXT;
			if (X.RDB$UPDATE_FLAG.NULL)
				field->fld_flags |= FLD_update_missing;
			else
				field->fld_update_flag = X.RDB$UPDATE_FLAG;

			COPY (X.RDB$FIELD_NAME, field->fld_name);

			if (!X.RDB$FIELD_SOURCE_SCHEMA_NAME.NULL)
				field->fld_source.schema = X.RDB$FIELD_SOURCE_SCHEMA_NAME;

			field->fld_source.object = X.RDB$FIELD_SOURCE;

			COPY (X.RDB$BASE_FIELD, field->fld_base);
			COPY (X.RDB$QUERY_NAME, field->fld_query_name);
			COPY (X.RDB$EDIT_STRING, field->fld_edit_string);
			COPY (X.RDB$COMPLEX_NAME, field->fld_complex_name);

			blob_id = &Y.RDB$COMPUTED_BLR;

			if (blob_id->gds_quad_low || blob_id->gds_quad_high) {
				field->fld_flags |= FLD_computed;
			}

			field->fld_system_flag = X.RDB$SYSTEM_FLAG;

			COPY (X.RDB$SECURITY_CLASS, field->fld_security_class);

			// use the fld_flags to mark the field as an array and
			// to differentiate it from other blobs

			if (Y.RDB$DIMENSIONS)
			{
				field->fld_flags |= FLD_array;
				field->fld_dimensions = Y.RDB$DIMENSIONS;
				if (field->fld_dimensions < 0)
				{
					BURP_error(52, true, SafeArg() << field->fld_name);
					// msg 52 array dimension for field %s is invalid
				}
				get_ranges (field);
			}

			if (!X.RDB$NULL_FLAG.NULL)
			{
				field->fld_null_flag = X.RDB$NULL_FLAG;
				field->fld_flags |= FLD_null_flag;
			}

			if (!X.RDB$DEFAULT_VALUE.NULL)
			{
				blob_id = &X.RDB$DEFAULT_VALUE;
				if (blob_id->gds_quad_low || blob_id->gds_quad_high) {
					field->fld_default_value = X.RDB$DEFAULT_VALUE;
				}
			}

			if (!X.RDB$DEFAULT_SOURCE.NULL)
			{
				blob_id = &X.RDB$DEFAULT_SOURCE;
				if (blob_id->gds_quad_low || blob_id->gds_quad_high) {
					field->fld_default_source = X.RDB$DEFAULT_SOURCE;
				}
			}

			if (!Y.RDB$CHARACTER_SET_ID.NULL)
			{
				field->fld_character_set_id = CSetId(Y.RDB$CHARACTER_SET_ID);
				field->fld_flags |= FLD_charset_flag;
			}

			if (!X.RDB$COLLATION_ID.NULL)
			{
				field->fld_collation_id = CollId(X.RDB$COLLATION_ID);
				field->fld_flags |= FLD_collate_flag;
			}

			// ODS 12
			if (!X.RDB$GENERATOR_NAME.NULL)
			{
				COPY(X.RDB$GENERATOR_NAME, field->fld_generator);
				field->fld_identity_type = X.RDB$IDENTITY_TYPE;
			}

			field_list.add(field);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}
	else
	{
		FOR (REQUEST_HANDLE tdgbl->handles_get_fields_req_handle1)
			X IN RDB$RELATION_FIELDS CROSS
			Y IN RDB$FIELDS WITH
			X.RDB$FIELD_SOURCE = Y.RDB$FIELD_NAME AND
			X.RDB$RELATION_NAME EQ relation->rel_name.object.c_str()
		{
			field = (burp_fld*) BURP_alloc_zero(sizeof(burp_fld));
			field->fld_number = count++;
			field->fld_type = Y.RDB$FIELD_TYPE;
			field->fld_sub_type = Y.RDB$FIELD_SUB_TYPE;
			field->fld_length = Y.RDB$FIELD_LENGTH;
			field->fld_scale = Y.RDB$FIELD_SCALE;
			field->fld_id = X.RDB$FIELD_ID;

			if (!X.RDB$DESCRIPTION.NULL)
			{
				blob_id = &X.RDB$DESCRIPTION;
				if (blob_id->gds_quad_low || blob_id->gds_quad_high)
					field->fld_description = X.RDB$DESCRIPTION;
			}

			if (!X.RDB$QUERY_HEADER.NULL)
			{
				blob_id = &X.RDB$QUERY_HEADER;
				if (blob_id->gds_quad_low || blob_id->gds_quad_high)
					field->fld_query_header = X.RDB$QUERY_HEADER;
			}

			if (X.RDB$FIELD_POSITION.NULL)
				field->fld_flags |= FLD_position_missing;
			else
				field->fld_position = X.RDB$FIELD_POSITION;
			field->fld_view_context = X.RDB$VIEW_CONTEXT;
			if (X.RDB$UPDATE_FLAG.NULL)
				field->fld_flags |= FLD_update_missing;
			else
				field->fld_update_flag = X.RDB$UPDATE_FLAG;

			COPY (X.RDB$FIELD_NAME, field->fld_name);
			field->fld_source.object = X.RDB$FIELD_SOURCE;
			COPY (X.RDB$BASE_FIELD, field->fld_base);
			COPY (X.RDB$QUERY_NAME, field->fld_query_name);
			COPY (X.RDB$EDIT_STRING, field->fld_edit_string);
			COPY (X.RDB$COMPLEX_NAME, field->fld_complex_name);

			blob_id = &Y.RDB$COMPUTED_BLR;

			if (blob_id->gds_quad_low || blob_id->gds_quad_high) {
				field->fld_flags |= FLD_computed;
			}

			field->fld_system_flag = X.RDB$SYSTEM_FLAG;

			COPY (X.RDB$SECURITY_CLASS, field->fld_security_class);

			// use the fld_flags to mark the field as an array and
			// to differentiate it from other blobs

			if (Y.RDB$DIMENSIONS)
			{
				field->fld_flags |= FLD_array;
				field->fld_dimensions = Y.RDB$DIMENSIONS;
				if (field->fld_dimensions < 0)
				{
					BURP_error(52, true, SafeArg() << field->fld_name);
					// msg 52 array dimension for field %s is invalid
				}
				get_ranges (field);
			}

			if (!X.RDB$NULL_FLAG.NULL)
			{
				field->fld_null_flag = X.RDB$NULL_FLAG;
				field->fld_flags |= FLD_null_flag;
			}

			if (!X.RDB$DEFAULT_VALUE.NULL)
			{
				blob_id = &X.RDB$DEFAULT_VALUE;
				if (blob_id->gds_quad_low || blob_id->gds_quad_high) {
					field->fld_default_value = X.RDB$DEFAULT_VALUE;
				}
			}

			if (!X.RDB$DEFAULT_SOURCE.NULL)
			{
				blob_id = &X.RDB$DEFAULT_SOURCE;
				if (blob_id->gds_quad_low || blob_id->gds_quad_high) {
					field->fld_default_source = X.RDB$DEFAULT_SOURCE;
				}
			}

			if (!Y.RDB$CHARACTER_SET_ID.NULL)
			{
				field->fld_character_set_id = CSetId(Y.RDB$CHARACTER_SET_ID);
				field->fld_flags |= FLD_charset_flag;
			}

			if (!X.RDB$COLLATION_ID.NULL)
			{
				field->fld_collation_id = CollId(X.RDB$COLLATION_ID);
				field->fld_flags |= FLD_collate_flag;
			}

			field_list.add(field);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}

	burp_fld* fields = NULL;

	while (field_list.getCount())
	{
		field = field_list.pop();
		field->fld_next = fields;
		fields = field;
	}

	return fields;
}


SINT64 get_gen_id(const QualifiedMetaString& name)
{
/**************************************
 *
 *	g e t _ g e n _ i d
 *
 **************************************
 *
 * Functional description
 *	Read id for a generator;
 *
 **************************************/
	try
	{
		BurpGlobals* tdgbl = BurpGlobals::getSpecific();

		Firebird::string sql;
		sql.printf(
			"select first(1) gen_id(%s, 0) from %srdb$database",
			name.toQuotedString().c_str(),
			(tdgbl->runtimeODS >= DB_VERSION_DDL14 ? "system." : ""));

		BurpSql getGenerator(tdgbl, sql.c_str());
		FB_MESSAGE(GetGen, Firebird::ThrowWrapper, (FB_BIGINT, id));
		GetGen getGen(&tdgbl->throwStatus, Firebird::MasterInterfacePtr());

		getGenerator.singleSelect(tdgbl->tr_handle, &getGen);
		return getGen->id;
	}
	catch (const status_exception& ex)
	{
		LocalStatus ls;
		ex.stuffException(&ls);

		// if there's no gen_id, never mind ...
		if (ls.getErrors()[1] == isc_dsql_error)
			return 0;

		BURP_error_redirect(&ls, 25);
		// msg 25 Failed in put_blr_gen_id
	}
	return 0;	// warning silencer
}


void get_ranges( burp_fld* field)
{
/**************************************
 *
 *	g e t _ r a n g e s
 *
 **************************************
 *
 * Functional description
 *	Fill in the range low and high bounds by reading
 *      the ranges in rdb$field_dimensions.
 *
 **************************************/
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	SLONG* rp = field->fld_ranges;
	USHORT count = 0;

	// Get the array dimensions in the rdb$field_dimensions

	FOR (REQUEST_HANDLE tdgbl->handles_get_ranges_req_handle1)
		X IN RDB$FIELD_DIMENSIONS
		WITH X.RDB$SCHEMA_NAME EQUIV NULLIF(field->fld_source.schema.c_str(), '') AND
			 X.RDB$FIELD_NAME EQ field->fld_source.object.c_str()
		SORTED BY X.RDB$DIMENSION
	{
		if (count != X.RDB$DIMENSION)
		{
			BURP_error(52, true, SafeArg() << field->fld_name);
			// msg 52 array dimension for field %s is invalid
		}
		*rp++ = X.RDB$LOWER_BOUND;
		*rp++ = X.RDB$UPPER_BOUND;
		count++;
	}
	END_FOR
	ON_ERROR
		general_on_error();
	END_ERROR

	if (count != field->fld_dimensions)
	{
		BURP_error(52, true, SafeArg() << field->fld_name);
		// msg 52 array dimension for field %s is invalid
	}
}


void put_array( burp_fld* field, burp_rel* relation, ISC_QUAD* blob_id)
{
/**************************************
 *
 *	p u t _ a r r a y
 *
 **************************************
 *
 * Functional description
 *	Write out an array.  If, however, it's null, don't even bother.
 *
 **************************************/
	SLONG range_buffer[16];	// enough for 16 dimensions
	UCHAR blr_buffer[200];		// enough for a sdl with 16 dimensions

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	// If the array is null, don't store it.  It will be restored as null.

	if (!blob_id->gds_quad_low && !blob_id->gds_quad_high)
		return;

	lstring xdr_buffer;
	xdr_buffer.lstr_allocated = 0;
	xdr_buffer.lstr_address = NULL;

	UCHAR* blr = blr_buffer;
	const SLONG* const end_ranges = field->fld_ranges + 2 * field->fld_dimensions;

	USHORT field_length = field->fld_length;
	if (tdgbl->gbl_sw_transportable)
		xdr_buffer.lstr_length = field_length + 3;

	// build the sdl

	add_byte(blr, isc_sdl_version1);

	add_byte(blr, isc_sdl_struct);
	add_byte(blr, 1);

	add_byte(blr, field->fld_type);

	switch (field->fld_type)
	{
	case blr_short:
	case blr_long:
	case blr_quad:
	case blr_int64:
	case blr_int128:
		add_byte(blr, field->fld_scale);
		break;
	case blr_text:
	case blr_varying:
		add_word(blr, field->fld_length);
		break;
	}

	if (field->fld_type == blr_varying)
		field_length += sizeof(USHORT);

	add_byte(blr, isc_sdl_rid);
	add_word(blr, relation->rel_id);
	add_byte(blr, isc_sdl_fid);
	add_word(blr, field->fld_id);

	USHORT count = 0;
	for (const SLONG* range = field->fld_ranges; range < end_ranges; range += 2, count++)
	{
		add_byte(blr, isc_sdl_do2);
		add_byte(blr, count);
		add_byte(blr, isc_sdl_long_integer);
		add_long(blr, range[0]);
		add_byte(blr, isc_sdl_long_integer);
		add_long(blr, range[1]);
	}

	add_byte(blr, isc_sdl_element);
	add_byte(blr, 1);
	add_byte(blr, isc_sdl_scalar);
	add_byte(blr, 0);
	add_byte(blr, field->fld_dimensions);

	for (count = 0; count < field->fld_dimensions; count++)
	{
		add_byte(blr, isc_sdl_variable);
		add_byte(blr, count);
	}

	add_byte(blr, isc_sdl_eoc);

#ifdef DEBUG
	if (debug_on)
		PRETTY_print_sdl(blr_buffer, NULL, NULL, 0);
#endif

	const USHORT blr_length = blr - blr_buffer;

	// compute the range size for each dimension = high_range - low_range

	ULONG slice_length = field_length;
	for (const SLONG* range = field->fld_ranges; range < end_ranges; range += 2)
	{
		slice_length *= (range[1] - range[0] + 1);
		if (tdgbl->gbl_sw_transportable)
			xdr_buffer.lstr_length *= (range[1] - range[0] + 1);
	}
	UCHAR* slice = BURP_alloc(slice_length);

	// allocate space for the XDR representation

	if (tdgbl->gbl_sw_transportable)
	{
		xdr_buffer.lstr_address = BURP_alloc(xdr_buffer.lstr_length);
		xdr_buffer.lstr_allocated = xdr_buffer.lstr_length;
	}

	FbLocalStatus status_vector;
	unsigned return_length = DB->getSlice(&status_vector, gds_trans, blob_id, blr_length, blr_buffer,
		0, nullptr,		// parameters for subset of an array handling
		slice_length, slice);

	if (!status_vector.isSuccess())
	{
		BurpMaster master;
		BURP_print(81, field->fld_name);
		// msg 81 error accessing blob field %s -- continuing
		BURP_print_status(&status_vector);
#ifdef DEBUG
		PRETTY_print_sdl(blr_buffer, NULL, NULL, 0);
#endif
		// CVC: At this point I would expected calls to deallocate memory
		// See the end of this function.
		BURP_free(slice);
		if (xdr_buffer.lstr_allocated)
			BURP_free(xdr_buffer.lstr_address);
		return;
	}

	if (return_length != slice_length)
	{
		// Ugh.  The full array wasn't returned.  We must recompute the top
		// element to backup.

		SLONG returned_elements = (return_length / field_length) - 1;

		SLONG* returned_range = range_buffer;
		const SLONG* range = end_ranges - 2;
		for (int i1 = 0, i3 = 0;
			 range >= field->fld_ranges; range -= 2, returned_range++, i1++)
		{
			int divisor = 1;
			for (int i2 = (2 * (i1 + 1) + 1); i2 <= field->fld_dimensions * 2; i2 += 2)
			{
				divisor *= (field->fld_ranges[i2] - field->fld_ranges[i2 - 1] + 1);
			}
			*returned_range = (returned_elements - 1) / divisor + field->fld_ranges[i3];
			returned_elements -= (*returned_range - field->fld_ranges[i3]) * divisor;
			i3 += 2;
		}
	}

	put(tdgbl, (UCHAR) rec_array);
	put_int32(att_blob_field_number, field->fld_number);
	put_int32(att_array_dimensions, field->fld_dimensions);

	SLONG* returned_range = range_buffer;
	for (const SLONG* range = field->fld_ranges; range < end_ranges; range += 2, returned_range++)
	{
		put_int32(att_array_range_low, (int) range[0]);
		if (return_length == slice_length)
			put_int32(att_array_range_high, (int) range[1]);
		else
			put_int32(att_array_range_high, (int) *returned_range);
	}

	put(tdgbl, att_blob_data);
	put(tdgbl, (UCHAR) (return_length));
	put(tdgbl, (UCHAR) (return_length >> 8));
	put(tdgbl, (UCHAR) (return_length >> 16));
	put(tdgbl, (UCHAR) (return_length >> 24));

	if (return_length)
	{
		const UCHAR* p;
		if (tdgbl->gbl_sw_transportable)
		{
			lstring xdr_slice;
			xdr_slice.lstr_allocated = xdr_slice.lstr_length = return_length;
			xdr_slice.lstr_address = slice;
			return_length = CAN_slice(&xdr_buffer, &xdr_slice, true, blr_buffer);
			put(tdgbl, att_xdr_array);
			put(tdgbl, (UCHAR) (return_length));
			put(tdgbl, (UCHAR) (return_length >> 8));
			put(tdgbl, (UCHAR) (return_length >> 16));
			put(tdgbl, (UCHAR) (return_length >> 24));
			p = xdr_buffer.lstr_address;
		}
		else
			p = slice;
		put_block(tdgbl, p, return_length);
	}

	BURP_free(slice);
	if (xdr_buffer.lstr_allocated)
		BURP_free(xdr_buffer.lstr_address);
}


void put_asciz( const att_type attribute, const TEXT* string)
{
/**************************************
 *
 *	p u t _ a s c i z
 *
 **************************************
 *
 * Functional description
 *	Write an attribute starting with a null terminated string.
 *	Currently it's only called by write_database with the db's name as param.
 *
 **************************************/
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	ULONG len = static_cast<ULONG>(strlen(string));
	// CVC: We'll have to ensure that length < MAX_FILE_NAME_SIZE.
	// For now, we'll truncate.
	// We can't honor operating systems that allow longer file names.
	if (len >= MAX_FILE_NAME_SIZE)
	{
		BURP_print(343, SafeArg() << int(attribute) << "put_asciz()" << (MAX_FILE_NAME_SIZE - 1));
		// msg 343: text for attribute @1 is too large in @2, truncating to @3 bytes
		len = MAX_FILE_NAME_SIZE - 1;
	}

	put(tdgbl, attribute);
	put(tdgbl, (UCHAR) len);
	if (len)
		put_block(tdgbl, (const UCHAR*) string, len);
}


void put_blob( burp_fld* field, ISC_QUAD& blob_id)
{
/**************************************
 *
 *	p u t _ b l o b
 *
 **************************************
 *
 * Functional description
 *	Write out a blob.  If, however, it's null, don't even bother.
 *	This is for user data blobs.
 *
 **************************************/
	FbLocalStatus status_vector;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	// If the blob is null, don't store it.  It will be restored as null.

	if (BlobWrapper::blobIsNull(blob_id))
		return;

	// Open the blob and get it's vital statistics

	BlobWrapper blob(&status_vector);

	if (!blob.open(DB, gds_trans, blob_id))
	{
		BurpMaster master;
		BURP_print(81, field->fld_name);
		// msg 81 error accessing blob field %s -- continuing
		BURP_print_status(&status_vector);
		return;
	}

	UCHAR blob_info[BUFFER_TINY];
	if (!blob.getInfo(sizeof(blob_items), blob_items, sizeof(blob_info), blob_info))
	{
		BURP_error_redirect(&status_vector, 20);
		// msg 20 isc_blob_info failed
	}

	put(tdgbl, (UCHAR) rec_blob);
	put_int32(att_blob_field_number, field->fld_number);

	ULONG segments = 0;
	FB_UINT64 total_length = 0;
	USHORT max_segment = 0;
	int blob_type = 0; // 0 - segmented, 1 - stream
	const UCHAR* p = blob_info;

	UCHAR item;
	while ((item = *p++) != isc_info_end)
	{
		const auto l = gds__vax_integer(p, 2);
		p += 2;
		const auto n = isc_portable_integer(p, l);
		p += l;

		switch (item)
		{
		case isc_info_blob_max_segment:
			max_segment = (USHORT) n;
			break;

		case isc_info_blob_type:
			blob_type = (int) n;
			break;

		case isc_info_blob_num_segments:
			segments = (ULONG) n;
			break;

		case isc_info_blob_total_length:
			total_length = (FB_UINT64) n;
			break;

		default:
			BURP_error(21, true, SafeArg() << int(item));
			// msg 21 don't understand blob info item %ld
		}
	}

	// NS: Compute number of chunks we are going to write for stream blob based
	// on total blob length and maximum segment size. This way we tend to
	// preserve maximum internal segment size over backup/restore. I'm not sure
	// this is beneficial, but let's do it for the moment instead of inventing
	// our own chunk size. Note, the number of segments returned by information
	// call for stream blob is always unreliable, even for zero-length blobs
	if (blob_type == 1)
		segments = total_length ? (total_length + max_segment - 1) / max_segment : 0;

	put_int32(att_blob_max_segment, max_segment);
	put_int32(att_blob_number_segments, segments);
	put_int32(att_blob_type, blob_type);

	// Allocate a buffer large enough for the largest segment and start grinding.
	UCHAR static_buffer[1024];
	UCHAR* buffer;
	if (!max_segment || max_segment <= sizeof(static_buffer))
		buffer = static_buffer;
	else
		buffer = BURP_alloc(max_segment);

	put(tdgbl, att_blob_data);

	while (segments > 0)
	{
		FB_SIZE_T segment_length;
		if (!blob.getSegment(max_segment, buffer, segment_length))
		{
			BURP_error_redirect(&status_vector, 22);
			// msg 22 isc_get_segment failed
		}

		put(tdgbl, (UCHAR) (segment_length));
		put(tdgbl, (UCHAR) (segment_length >> 8));
		if (segment_length)
		{
			put_block(tdgbl, buffer, segment_length);
		}
		--segments;
	}

	if (!blob.close())
	{
		BURP_error_redirect(&status_vector, 23);
		// msg 23 isc_close_blob failed
	}

	if (buffer != static_buffer)
		BURP_free(buffer);
}


bool put_blr_blob( att_type attribute, ISC_QUAD& blob_id)
{
/**************************************
 *
 *	p u t _ b l r _ b l o b
 *
 **************************************
 *
 * Functional description
 *	Write out a blr blob, if present.  Otherwise do nothing.
 *	Return true if the blob was present, false otherwise.
 *
 **************************************/
	FbLocalStatus status_vector;
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	// If the blob is null, don't store it.  It will be restored as null.

	if (BlobWrapper::blobIsNull(blob_id))
		return false;

	// Open the blob and get it's vital statistics

	BlobWrapper blob(&status_vector);

	if (!blob.open(DB, gds_trans, blob_id))
	{
		BURP_error_redirect(&status_vector, 24);
		// msg 24 isc_open_blob failed
	}

	UCHAR blob_info[BUFFER_TINY];
	if (!blob.getInfo(sizeof(blr_items), blr_items, sizeof(blob_info), blob_info))
	{
		BURP_error_redirect(&status_vector, 20);
		// msg 20 isc_blob_info failed
	}

	FB_UINT64 length = 0;
	USHORT max_segment = 0;
	const UCHAR* p = blob_info;
	UCHAR item;

	while ((item = *p++) != isc_info_end)
	{
		const auto l = gds__vax_integer(p, 2);
		p += 2;
		const auto n = isc_portable_integer(p, l);
		p += l;

		switch (item)
		{
		case isc_info_blob_max_segment:
			max_segment = (USHORT) n;
			break;

		case isc_info_blob_total_length:
			length = (FB_UINT64) n;
			break;

		default:
			BURP_print(79, SafeArg() << int(item));
			// msg 79 don't understand blob info item %ld
			if (!blob.close())
			{
				BURP_error_redirect(&status_vector, 23);
				// msg 23 isc_close_blob failed
			}
			return false;
		}
	}

	if (!length || length > MAX_ULONG)
	{
		if (!blob.close())
		{
			BURP_error_redirect(&status_vector, 23);
			// msg 23 isc_close_blob failed
		}
		return false;
	}

	// Rdb sometimes gets the length messed up

	if (length < max_segment)
		length = max_segment;

	put_int32(attribute, (int) length);

	// Allocate a buffer large enough for the largest segment and start grinding.

	UCHAR static_buffer[1024];
	UCHAR* buffer;
	if (!max_segment || max_segment <= sizeof(static_buffer))
		buffer = static_buffer;
	else
		buffer = BURP_alloc(max_segment);

	// The old code didn't accept isc_segment so we check it.
	FB_SIZE_T segment_length;
	while (blob.getSegment(max_segment, buffer, segment_length) && !blob.getCode())
	{
		if (segment_length)
		{
			put_block(tdgbl, buffer, segment_length);
		}
	}

	if (!blob.close())
	{
		BURP_error_redirect(&status_vector, 23);
		// msg 23 isc_close_blob failed
	}

	if (buffer != static_buffer)
		BURP_free(buffer);

	return true;
}


void put_data(burp_rel* relation, ReadRelationReq* request)
{
/**************************************
 *
 *	p u t _ d a t a
 *
 **************************************
 *
 * Functional description
 *	Write relation meta-data and data.
 *
 **************************************/
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();
	BackupRelationTask* task = BackupRelationTask::getBackupTask(tdgbl);
	const ReadRelationMeta* reqMeta = request->getMeta();

	HalfStaticArray<burp_fld*, 4> blobFlds;
	HalfStaticArray<burp_fld*, 4> arrayFlds;

	SSHORT count = 0;
	burp_fld* field;
	for (field = relation->rel_fields; field; field = field->fld_next)
	{
		if (field->fld_flags & FLD_computed)
			continue;

		count += 2;

		if (field->fld_flags & FLD_array)
			arrayFlds.add(field);
		else if (field->fld_type == blr_blob)
			blobFlds.add(field);
	}
	count++; // eof

	FbLocalStatus status;
	request->start(&status, gds_trans);
	if (status->getState() & IStatus::STATE_ERRORS)
	{
		BURP_error_redirect(&status, 28);
		// msg 28 isc_start_request failed
	}

	// Here is the crux of the problem -- writing data.  All this work
	// for the following small loop.

	const UCHAR* buffer = request->getData();

	// the XDR representation may be even fluffier
	lstring xdr_buffer;
	if (tdgbl->gbl_sw_transportable)
	{
		xdr_buffer.lstr_length = xdr_buffer.lstr_allocated = reqMeta->m_outMsgLen + count * 3;
		xdr_buffer.lstr_address = BURP_alloc(xdr_buffer.lstr_length);
	}
	else
		xdr_buffer.lstr_address = NULL;

	RCRD_LENGTH record_length = reqMeta->m_outRecLen;

	while (true)
	{
		if (task->isStopped())
			break;

		request->receive(&status);
		if (status->getState() & IStatus::STATE_ERRORS)
		{
			BURP_error_redirect(&status, 29);
			// msg 29 isc_receive failed
		}
		if (!request->eof())
			break;

		put(tdgbl, (UCHAR) rec_data);
		put_int32(att_data_length, record_length);
		const UCHAR* p;
		if (tdgbl->gbl_sw_transportable)
		{
			record_length = CAN_encode_decode(relation, &xdr_buffer, const_cast<UCHAR*>(buffer), TRUE);
			put_int32(att_xdr_length, record_length);
			p = xdr_buffer.lstr_address;
		}
		else
			p = buffer;
		put(tdgbl, att_data_data);
		if (tdgbl->gbl_sw_compress)
			compress(p, record_length);
		else if (record_length)
			put_block(tdgbl, p, record_length);

		// Look for any blobs to write

		for (burp_fld** pField = blobFlds.begin(); pField < blobFlds.end(); pField++)
		{
			if (task->isStopped())
				break;

			field = *pField;
			put_blob(field, *(ISC_QUAD*) (buffer + field->fld_offset));
		}

		// Look for any array to write
		// we got back the blob_id for the array from isc_receive in the second param.
		for (burp_fld** pField = arrayFlds.begin(); pField < arrayFlds.end(); pField++)
		{
			if (task->isStopped())
				break;

			field = *pField;
			put_array(field, relation, (ISC_QUAD*)(buffer + field->fld_offset));
		}

		BackupRelationTask::recordAdded(tdgbl);
	}

	if (xdr_buffer.lstr_address)
		BURP_free(xdr_buffer.lstr_address);
}


void put_index( burp_rel* relation)
{
/**************************************
 *
 *	p u t _ i n d e x
 *
 **************************************
 *
 * Functional description
 *	Write information about an index.  First
 *	check that all the segments of the
 *	index exist.
 *
 **************************************/
	ULONG count;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	// if we have all capabilities, use the first request to get the
	// most performance out of the latest engine; if we don't
	// have one of the capabilities we must use the second set of
	// requests--this requires more code but it is well worth it
	// for the performance benefits, especially remotely--deej

	if (tdgbl->runtimeODS >= DB_VERSION_DDL13_1)
	{
		FOR (REQUEST_HANDLE tdgbl->handles_put_index_req_handle1)
			X IN RDB$INDICES WITH
			X.RDB$SCHEMA_NAME EQUIV NULLIF(relation->rel_name.schema.c_str(), '') AND
			X.RDB$RELATION_NAME EQ relation->rel_name.object.c_str() AND
			X.RDB$INDEX_NAME NOT STARTING TEMP_DEPEND
		{
			count = 0;
			FOR (REQUEST_HANDLE tdgbl->handles_put_index_req_handle2)
				I_S IN RDB$INDEX_SEGMENTS CROSS
				RFR IN RDB$RELATION_FIELDS WITH
				I_S.RDB$FIELD_NAME = RFR.RDB$FIELD_NAME AND
				I_S.RDB$SCHEMA_NAME EQUIV RFR.RDB$SCHEMA_NAME AND
				I_S.RDB$INDEX_NAME = X.RDB$INDEX_NAME AND
				RFR.RDB$SCHEMA_NAME EQUIV NULLIF(relation->rel_name.schema.c_str(), '') AND
				RFR.RDB$RELATION_NAME = relation->rel_name.object.c_str()
			{
				count++;
			}
			END_FOR
			ON_ERROR
				general_on_error();
			END_ERROR;

			if (count != (ULONG) X.RDB$SEGMENT_COUNT)
			{
				BURP_print(180, SafeArg() << X.RDB$INDEX_NAME << count << X.RDB$SEGMENT_COUNT);
				continue;
			}

			put(tdgbl, rec_index);
			PUT_TEXT(att_index_name, X.RDB$INDEX_NAME);
			BURP_verbose(151, QualifiedMetaString(X.RDB$INDEX_NAME, relation->rel_name.schema).toQuotedString());
			// msg 151 writing index %s

			put_int32 (att_segment_count, X.RDB$SEGMENT_COUNT);
			put_int32 (att_index_inactive, X.RDB$INDEX_INACTIVE);
			put_int32 (att_index_unique_flag, X.RDB$UNIQUE_FLAG);

			FOR (REQUEST_HANDLE tdgbl->handles_put_index_req_handle5)
				Y IN RDB$INDEX_SEGMENTS WITH
				Y.RDB$SCHEMA_NAME EQUIV NULLIF(relation->rel_name.schema.c_str(), '') AND
				Y.RDB$INDEX_NAME EQ X.RDB$INDEX_NAME
				SORTED BY Y.RDB$FIELD_POSITION
			{
				PUT_TEXT (att_index_field_name, Y.RDB$FIELD_NAME);
			}
			END_FOR
			ON_ERROR
				general_on_error();
			END_ERROR;

			put_source_blob (att_index_description2, att_index_description, X.RDB$DESCRIPTION);
			put_int32 (att_index_type, X.RDB$INDEX_TYPE);

			if (!X.RDB$EXPRESSION_SOURCE.NULL)
			{
				put_source_blob(att_index_expression_source, att_index_expression_source,
								X.RDB$EXPRESSION_SOURCE);
			}
			if (!X.RDB$EXPRESSION_BLR.NULL)
				put_blr_blob(att_index_expression_blr, X.RDB$EXPRESSION_BLR);

			if (!X.RDB$FOREIGN_KEY_SCHEMA_NAME.NULL)
				PUT_TEXT(att_index_foreign_key_schema_name, X.RDB$FOREIGN_KEY_SCHEMA_NAME);

			if (!X.RDB$FOREIGN_KEY.NULL)
				PUT_TEXT (att_index_foreign_key, X.RDB$FOREIGN_KEY);

			if (!X.RDB$CONDITION_SOURCE.NULL)
			{
				put_source_blob(att_index_condition_source, att_index_condition_source,
								X.RDB$CONDITION_SOURCE);
			}
			if (!X.RDB$CONDITION_BLR.NULL)
				put_blr_blob(att_index_condition_blr, X.RDB$CONDITION_BLR);

			put(tdgbl, att_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR;
	}
	else
	{
		FOR (REQUEST_HANDLE tdgbl->handles_put_index_req_handle1)
			X IN RDB$INDICES WITH
			X.RDB$RELATION_NAME EQ relation->rel_name.object.c_str()

			count = 0;
			FOR (REQUEST_HANDLE tdgbl->handles_put_index_req_handle2)
				I_S IN RDB$INDEX_SEGMENTS CROSS
				RFR IN RDB$RELATION_FIELDS WITH
				I_S.RDB$FIELD_NAME = RFR.RDB$FIELD_NAME AND
				I_S.RDB$INDEX_NAME = X.RDB$INDEX_NAME AND
				RFR.RDB$RELATION_NAME = relation->rel_name.object.c_str()

				count++;

			END_FOR;
			ON_ERROR
				general_on_error();
			END_ERROR;

			if (count != (ULONG) X.RDB$SEGMENT_COUNT)
			{
				BURP_print(180, SafeArg() << X.RDB$INDEX_NAME << count << X.RDB$SEGMENT_COUNT);
				continue;
			}

			put(tdgbl, rec_index);
			PUT_TEXT(att_index_name, X.RDB$INDEX_NAME);
			BURP_verbose(151, MetaString(X.RDB$INDEX_NAME).toQuotedString());
			// msg 151 writing index %s
			put_int32 (att_segment_count, X.RDB$SEGMENT_COUNT);
			put_int32 (att_index_inactive, X.RDB$INDEX_INACTIVE);
			put_int32 (att_index_unique_flag, X.RDB$UNIQUE_FLAG);

			FOR (REQUEST_HANDLE tdgbl->handles_put_index_req_handle5)
				Y IN RDB$INDEX_SEGMENTS WITH
				Y.RDB$INDEX_NAME EQ X.RDB$INDEX_NAME
				SORTED BY Y.RDB$FIELD_POSITION

				PUT_TEXT (att_index_field_name, Y.RDB$FIELD_NAME);

			END_FOR;
			ON_ERROR
				general_on_error();
			END_ERROR;

			put_source_blob (att_index_description2, att_index_description, X.RDB$DESCRIPTION);
			put_int32 (att_index_type, X.RDB$INDEX_TYPE);

			if (!X.RDB$EXPRESSION_SOURCE.NULL)
			{
				put_source_blob(att_index_expression_source, att_index_expression_source,
								X.RDB$EXPRESSION_SOURCE);
			}
			if (!X.RDB$EXPRESSION_BLR.NULL)
				put_blr_blob(att_index_expression_blr, X.RDB$EXPRESSION_BLR);

			if (!X.RDB$FOREIGN_KEY.NULL)
				PUT_TEXT (att_index_foreign_key, X.RDB$FOREIGN_KEY);

			put(tdgbl, att_end);

		END_FOR;
		ON_ERROR
			general_on_error();
		END_ERROR;
	}
}


int put_message( att_type attribute, att_type attribute2, const TEXT* text, const ULONG length)
{
/**************************************
 *
 *	p u t _ m e s s a g e
 *
 **************************************
 *
 * Functional description
 *	Write a variable length text string, with embedded
 *      blanks.  Same as put_text but handles embedded blanks.
 * CVC: As v6 time, put_text handles embedded blanks, too!
 * The only difference is that put_text's length is UCHAR, so
 * in theory put_message can handle much longer input and it's
 * used for exception and trigger's messages (plus update/delete
 * rules for FKs and constraint types, where it's irrelevant
 * which function of the two you use).
 * CVC: Responsability for FKs and constraint types transferred to put_text.
 * This function tries to maintain backwards compatibility where possible.
 *
 **************************************/
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	ULONG len = 0;
	for (const TEXT* p = text; *p && len < length; p++)
		len++;

	const ULONG newlen = MIN(len, length);
	fb_assert(newlen <= MAX_USHORT);

	// If we can store the message using the old format, we do it.
	if (newlen <= MAX_UCHAR)
	{
		put(tdgbl, attribute);
		put(tdgbl, (UCHAR) newlen);
	}
	else if (newlen <= MAX_USHORT)
	{
		if (!attribute2) // In theory, this never happens, because the caller knows what it's doing.
			BURP_error(314, true);
		put(tdgbl, attribute2);
		USHORT vax_value = (USHORT) newlen;
		vax_value = (USHORT) gds__vax_integer((const UCHAR*) &vax_value, sizeof(vax_value));
		put_block(tdgbl, (const UCHAR*) &vax_value, sizeof(vax_value));
	}
	else
		BURP_error(315, true);

	if (newlen)
		put_block(tdgbl, reinterpret_cast<const UCHAR*>(text), newlen);

	return newlen;
}


void put_int32( att_type attribute, SLONG value)
{
/**************************************
 *
 *	p u t _ i n t 3 2
 *
 **************************************
 *
 * Functional description
 *	Write a numeric value as an attribute.  The number is represented
 *	low byte first, high byte last, as in VAX.
 *
 **************************************/
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	const SLONG vax_value = (SLONG) isc_vax_integer((const char*) &value, sizeof(value));

	put(tdgbl, attribute);
	put(tdgbl, (UCHAR) sizeof(value));
	put_block(tdgbl, (const UCHAR*) &vax_value, sizeof(vax_value));
}


void put_int64(att_type attribute, SINT64 value)
{
/**************************************
 *
 *	p u t _ i n t 6 4
 *
 **************************************
 *
 * Functional description
 *	Write a 64-bit numeric value as an attribute.
 *      The number is represented low byte first, high byte last, as in VAX.
 *      This function is just like put_int32, except that it handles an
 *      INT64 value, while put_int32 handles a 32-bit value.
 *
 **************************************/
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	const FB_UINT64 le_value = (FB_UINT64) isc_portable_integer((const UCHAR*) &value, sizeof(value));

	put(tdgbl, attribute);
	put(tdgbl, (UCHAR) sizeof(value));
	put_block(tdgbl, (const UCHAR*) &le_value, sizeof(le_value));
}


void put_boolean(att_type attribute, const FB_BOOLEAN value)
{
/**************************************
 *
 *	p u t _ b o o l e a n
 *
 **************************************
 *
 * Functional description
 *	Write a FB_BOOLEAN value as an attribute.
 **************************************/
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	put(tdgbl, attribute);
	put(tdgbl, (UCHAR) 1);
	put(tdgbl, value ? 1u : 0u);
}


void put_relation( burp_rel* relation)
{
/**************************************
 *
 * 	p u t _ r e l a t i o n
 *
 **************************************
 *
 * Functional description
 *	Write relation meta-data and data.
 *
 **************************************/
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	// Write local field information.  This is made slightly more complicated
	// by the requirement that computational fields be aligned.

	burp_fld* aligned = NULL;
	burp_fld* unaligned = NULL;
	burp_fld* aligned4 = NULL;
	burp_fld* aligned8 = NULL;
	burp_fld* aligned16 = NULL;

	burp_fld* fields = get_fields(relation);

	// sort the list of fields into three lists, depending on alignment
	burp_fld* field;
	for (field = fields; (field = fields);)
	{
		fields = field->fld_next;
		USHORT l = field->fld_length;
		if (field->fld_type == blr_varying)
			l += sizeof(USHORT);

		if (!(l & 15))
		{
			field->fld_next = aligned16;
			aligned16 = field;
		}
		else if (!(l & 7))
		{
			field->fld_next = aligned8;
			aligned8 = field;
		}
		else if (!(l & 3))
		{
			field->fld_next = aligned4;
			aligned4 = field;
		}
		else if (l & 1)
		{
			field->fld_next = unaligned;
			unaligned = field;
		}
		else
		{
			field->fld_next = aligned;
			aligned = field;
		}
	}

	// Next, merge the aligned and unaligned sub-lists.  In the process,
	// re-create (approximately) the original order of the fields.  This is
	// not strictly required, but it certainly is polite.

	while ((field = unaligned))
	{
		unaligned = field->fld_next;
		field->fld_next = relation->rel_fields;
		relation->rel_fields = field;
	}

	while ((field = aligned))
	{
		aligned = field->fld_next;
		field->fld_next = relation->rel_fields;
		relation->rel_fields = field;
	}

	while ((field = aligned4))
	{
		aligned4 = field->fld_next;
		field->fld_next = relation->rel_fields;
		relation->rel_fields = field;
	}

	while ((field = aligned8))
	{
		aligned8 = field->fld_next;
		field->fld_next = relation->rel_fields;
		relation->rel_fields = field;
	}

	while ((field = aligned16))
	{
		aligned16 = field->fld_next;
		field->fld_next = relation->rel_fields;
		relation->rel_fields = field;
	}

	// Now write the fields in what will become physical backup order

	for (field = relation->rel_fields; field; field = field->fld_next)
	{
		put(tdgbl, (UCHAR) rec_field);
		PUT_TEXT(att_field_name, field->fld_name);
		BURP_verbose(144, MetaString(field->fld_name).toQuotedString());
		// msg 144  writing field %s

		if (field->fld_source.schema.hasData())
			put_text(att_field_schema_name, field->fld_source.schema);

		put_text(att_field_source, field->fld_source.object);

		if (field->fld_query_name[0])
			PUT_TEXT(att_field_query_name, field->fld_query_name);
		if (field->fld_complex_name[0])
			PUT_TEXT(att_field_complex_name, field->fld_complex_name);
		if (field->fld_edit_string[0])
			PUT_TEXT(att_field_edit_string, field->fld_edit_string);
		put_source_blob(att_field_description2, att_field_description, field->fld_description);
		put_source_blob(att_field_query_header, att_field_query_header, field->fld_query_header);
		if (field->fld_security_class[0])
			PUT_TEXT(att_field_security_class, field->fld_security_class);
		if (!(field->fld_flags & FLD_position_missing))
			put_int32(att_field_position, field->fld_position);
		put_int32(att_field_type, field->fld_type);
		put_int32(att_field_length, field->fld_length);
		put_int32(att_field_sub_type, field->fld_sub_type);
		put_int32(att_field_scale, field->fld_scale);
		put_int32(att_field_number, field->fld_number);
		put_int32(att_field_system_flag, field->fld_system_flag);
		if (!(field->fld_flags & FLD_update_missing))
			put_int32(att_field_update_flag, field->fld_update_flag);
		if (field->fld_flags & FLD_null_flag)
			put_int32(att_field_null_flag, field->fld_null_flag);
		if (field->fld_flags & FLD_charset_flag)
			put_int32(att_field_character_set, field->fld_character_set_id);
		if (field->fld_flags & FLD_collate_flag)
			put_int32(att_field_collation_id, field->fld_collation_id);
		put_blr_blob(att_field_default_value, field->fld_default_value);
		put_source_blob(att_field_default_source, att_field_default_source, field->fld_default_source);

		if (relation->rel_flags & REL_view)
		{
			put_int32(att_view_context, field->fld_view_context);
			if (field->fld_base[0])
				PUT_TEXT(att_base_field, field->fld_base);
		}

		if (field->fld_flags & FLD_computed)
			put_int32(att_field_computed_flag, TRUE);

		if (field->fld_flags & FLD_array)
		{
			put_int32(att_field_dimensions, field->fld_dimensions);
			const SLONG* rp = field->fld_ranges;
			for (USHORT n = field->fld_dimensions; n; rp += 2, n--)
			{
				put_int32(att_field_range_low, *rp);
				put_int32(att_field_range_high, *(rp + 1));
			}
		}

		if (field->fld_generator[0])
		{
			PUT_TEXT(att_field_generator_name, field->fld_generator);
			put_int32(att_field_identity_type, field->fld_identity_type);
		}

		put(tdgbl, att_end);
	}

	// Write out view relations (if a view, of course)

	if (relation->rel_flags & REL_view)
	{
		if (tdgbl->runtimeODS >= DB_VERSION_DDL12)
		{
			FOR (REQUEST_HANDLE tdgbl->handles_put_relation_req_handle1)
				X IN RDB$VIEW_RELATIONS
				WITH X.RDB$SCHEMA_NAME EQUIV NULLIF(relation->rel_name.schema.c_str(), '') AND
					 X.RDB$VIEW_NAME EQ relation->rel_name.object.c_str()
			{
				put(tdgbl, rec_view);

				if (!X.RDB$RELATION_SCHEMA_NAME.NULL)
					PUT_TEXT(att_view_relation_schema_name, X.RDB$RELATION_SCHEMA_NAME);

				PUT_TEXT(att_view_relation_name, X.RDB$RELATION_NAME);

				put_int32 (att_view_context_id, X.RDB$VIEW_CONTEXT);
				// Will need PUT_MESSAGE if this field grows to more than 255 bytes.
				PUT_TEXT (att_view_context_name, X.RDB$CONTEXT_NAME);
				if (!X.RDB$CONTEXT_TYPE.NULL)
					put_int32(att_view_context_type, X.RDB$CONTEXT_TYPE);
				if (!X.RDB$PACKAGE_NAME.NULL)
					PUT_TEXT(att_view_context_package, X.RDB$PACKAGE_NAME);
				put(tdgbl, att_end);
			}
			END_FOR
			ON_ERROR
				general_on_error();
			END_ERROR;
		}
		else
		{
			FOR (REQUEST_HANDLE tdgbl->handles_put_relation_req_handle1)
				X IN RDB$VIEW_RELATIONS WITH X.RDB$VIEW_NAME EQ relation->rel_name.object.c_str()
				put(tdgbl, rec_view);
				PUT_TEXT (att_view_relation_name, X.RDB$RELATION_NAME);
				put_int32 (att_view_context_id, X.RDB$VIEW_CONTEXT);
				PUT_TEXT (att_view_context_name, X.RDB$CONTEXT_NAME);
				put(tdgbl, att_end);
			END_FOR
			ON_ERROR
				general_on_error();
			END_ERROR;
		}
	}
	else if (!tdgbl->gbl_sw_meta)
	{
		FOR(REQUEST_HANDLE tdgbl->handles_put_relation_req_handle3)
			FIRST 1 P IN RDB$PAGES WITH P.RDB$RELATION_ID EQ relation->rel_id
			AND P.RDB$PAGE_TYPE = pag_pointer
			SORTED BY DESCENDING P.RDB$PAGE_SEQUENCE
			relation->rel_max_pp = P.RDB$PAGE_SEQUENCE;
		END_FOR;
		ON_ERROR
			general_on_error();
		END_ERROR;
	}
	put(tdgbl, (UCHAR)rec_relation_end);
}


bool put_source_blob(att_type attribute, att_type old_attribute, ISC_QUAD& blob_id)
{
/**************************************
 *
 *	p u t _ s o u r c e _ b l o b
 *
 **************************************
 *
 * Functional description
 *	Write out a source blob or query header if present.
 *	Return true is there was the blob was present, false otherwise.
 *	Include the NULL character to separate each segment.
 *
 **************************************/
	FbLocalStatus status_vector;
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	// If the blob is null, don't store it.  It will be restored as null.

	if (BlobWrapper::blobIsNull(blob_id))
		return false;

	if (tdgbl->gbl_sw_old_descriptions && attribute != att_field_query_header)
		return put_blr_blob(old_attribute, blob_id);

	// Open the blob and get it's vital statistics

	BlobWrapper blob(&status_vector);

	if (!blob.open(DB, gds_trans, blob_id))
	{
		BURP_error_redirect(&status_vector, 24);
		// msg 24 isc_open_blob failed
	}

	UCHAR blob_info[BUFFER_TINY];
	if (!blob.getInfo(sizeof(source_items), source_items, sizeof(blob_info), blob_info))
	{
		BURP_error_redirect(&status_vector, 20);
		// msg 20 isc_blob_info failed
	}

	FB_UINT64 length = 0;
	ULONG num_seg = 0;
	USHORT max_segment = 0;
	const UCHAR* p = blob_info;
	UCHAR item;

	while ((item = *p++) != isc_info_end)
	{
		const auto l = gds__vax_integer(p, 2);
		p += 2;
		const auto n = isc_portable_integer(p, l);
		p += l;

		switch (item)
		{
		case isc_info_blob_max_segment:
			max_segment = (USHORT) n;
			break;

		case isc_info_blob_total_length:
			length = (FB_UINT64) n;
			break;

		case isc_info_blob_num_segments:
			num_seg = (ULONG) n;
			break;

		default:
			BURP_print(79, SafeArg() << int(item));
			// msg 79 don't understand blob info item %ld
			if (!blob.close())
			{
				BURP_error_redirect(&status_vector, 23);
				// msg 23 isc_close_blob failed
			}
			return false;
		}
	}

	if (!length || length > MAX_ULONG)
	{
		if (!blob.close())
		{
			BURP_error_redirect(&status_vector, 23);
			// msg 23 isc_close_blob failed
		}
		return false;
	}

	// Rdb sometimes gets the length messed up

	if (length < max_segment)
		length = max_segment;

	fb_assert(FB_UINT64(length) + num_seg <= FB_UINT64(MAX_ULONG));
	put_int32(attribute, length + num_seg);

	// Allocate a buffer large enough for the largest segment and start grinding.

	UCHAR static_buffer[1024];
	UCHAR* buffer;
	if (!max_segment || max_segment <= sizeof(static_buffer))
		buffer = static_buffer;
	else
		buffer = BURP_alloc(max_segment);

	// The old code didn't accept isc_segment so we check it.
	FB_SIZE_T segment_length;
	while (blob.getSegment(max_segment, buffer, segment_length) && !blob.getCode())
	{
		if (segment_length)
		{
			put_block(tdgbl, buffer, segment_length);
		}
		put(tdgbl, (UCHAR) 0);
	}

	if (!blob.close())
	{
		BURP_error_redirect(&status_vector, 23);
		// msg 23 isc_close_blob failed
	}

	if (buffer != static_buffer)
		BURP_free(buffer);

	return true;
}


int put_text(att_type attribute, const TEXT* text, SSHORT size_len)
{
/**************************************
 *
 *	p u t _ t e x t
 *
 **************************************
 *
 * Functional description
 * Write a variable length text string, with embedded spaces.
 * Truncate trailing spaces.
 * Now this routine does not truncate trailing spaces, 3-2002 MOD
 * transferring changes from fb1, I believe this is to do with problems
 * with quoted names and embedded spaces.
 * CVC: This routine does trailing spaces truncation, but correctly.
 *
 **************************************/
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	SSHORT l = (SSHORT) MISC_symbol_length(text, (ULONG) size_len);
	fb_assert(l <= MAX_UCHAR);
	if (l > MAX_UCHAR)
	{
		BURP_print(343, SafeArg() << int(attribute) << "put_text()" << MAX_UCHAR);
		// msg 343: text for attribute @1 is too large in @2, truncating to @3 bytes
		l = MAX_UCHAR;
	}

	put(tdgbl, attribute);
	put(tdgbl, (UCHAR) l);
	if (l)
		put_block(tdgbl, (const UCHAR*) text, l);

	return l;
}


int put_text(att_type attribute, const MetaString& name)
{
	return put_text(attribute, name.c_str(), name.length() + 1);
}


void write_character_sets()
{
/**************************************
 *
 *	w r i t e _ c h a r a c t e r _ s e t s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each user defined character set.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	if (tdgbl->runtimeODS >= DB_VERSION_DDL12)
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$CHARACTER_SETS
			WITH X.RDB$SYSTEM_FLAG NE 1 OR
				 NOT (X.RDB$DEFAULT_COLLATE_SCHEMA_NAME EQUIV X.RDB$SCHEMA_NAME AND
					  X.RDB$DEFAULT_COLLATE_NAME = X.RDB$CHARACTER_SET_NAME)
		{
			put(tdgbl, rec_charset);

			if (!X.RDB$SCHEMA_NAME.NULL)
				PUT_TEXT(att_charset_schema_name, X.RDB$SCHEMA_NAME);

			PUT_TEXT (att_charset_name, X.RDB$CHARACTER_SET_NAME);

			if (X.RDB$SYSTEM_FLAG != 1)
			{
				if (!X.RDB$FORM_OF_USE.NULL)
					PUT_TEXT (att_charset_form, X.RDB$FORM_OF_USE);
				if (!X.RDB$NUMBER_OF_CHARACTERS.NULL)
					put_int32 (att_charset_numchar, X.RDB$NUMBER_OF_CHARACTERS);
				put_int32 (att_charset_id, X.RDB$CHARACTER_SET_ID);
				if (X.RDB$SYSTEM_FLAG)
					put_int32 (att_charset_sysflag, X.RDB$SYSTEM_FLAG);
				if (!X.RDB$DESCRIPTION.NULL)
				{
					put_source_blob (att_charset_description, att_charset_description, X.RDB$DESCRIPTION);
				}
				if (!X.RDB$FUNCTION_NAME.NULL)
					PUT_TEXT (att_charset_funct, X.RDB$FUNCTION_NAME);
				put_int32 (att_charset_bytes_char, X.RDB$BYTES_PER_CHARACTER);

				// CVC: Not sure if this code goes inside or outside this "if" block.
				if (!X.RDB$SECURITY_CLASS.NULL)
					PUT_TEXT(att_charset_security_class, X.RDB$SECURITY_CLASS);
				if (!X.RDB$OWNER_NAME.NULL)
					PUT_TEXT(att_charset_owner_name, X.RDB$OWNER_NAME);
			}

			if (!X.RDB$DEFAULT_COLLATE_SCHEMA_NAME.NULL)
				PUT_TEXT(att_charset_coll_schema_name, X.RDB$DEFAULT_COLLATE_SCHEMA_NAME);

			PUT_TEXT(att_charset_coll, X.RDB$DEFAULT_COLLATE_NAME);
			put(tdgbl, att_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}
	else
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$CHARACTER_SETS
			WITH X.RDB$SYSTEM_FLAG MISSING OR X.RDB$SYSTEM_FLAG NE 1 OR
				 X.RDB$DEFAULT_COLLATE_NAME NE X.RDB$CHARACTER_SET_NAME

			put(tdgbl, rec_charset);
			PUT_TEXT (att_charset_name, X.RDB$CHARACTER_SET_NAME);

			if (X.RDB$SYSTEM_FLAG.NULL || X.RDB$SYSTEM_FLAG != 1)
			{
				if (!X.RDB$FORM_OF_USE.NULL)
					PUT_TEXT (att_charset_form, X.RDB$FORM_OF_USE);
				if (!X.RDB$NUMBER_OF_CHARACTERS.NULL)
					put_int32 (att_charset_numchar, X.RDB$NUMBER_OF_CHARACTERS);
				put_int32 (att_charset_id, X.RDB$CHARACTER_SET_ID);
				if (X.RDB$SYSTEM_FLAG)
					put_int32 (att_charset_sysflag, X.RDB$SYSTEM_FLAG);
				if (!X.RDB$DESCRIPTION.NULL)
				{
					put_source_blob (att_charset_description, att_charset_description, X.RDB$DESCRIPTION);
				}
				if (!X.RDB$FUNCTION_NAME.NULL)
					PUT_TEXT (att_charset_funct, X.RDB$FUNCTION_NAME);
				put_int32 (att_charset_bytes_char, X.RDB$BYTES_PER_CHARACTER);
			}

			PUT_TEXT (att_charset_coll, X.RDB$DEFAULT_COLLATE_NAME);
			put(tdgbl, att_end);
		END_FOR;
		ON_ERROR
			general_on_error();
		END_ERROR;
	}

	MISC_release_request_silent(req_handle1);
}


void write_check_constraints()
{
/**************************************
 *
 *	w r i t e _ c h e c k _ c o n s t r a i n t s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each check constraint.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	FOR (REQUEST_HANDLE req_handle1)
		X IN RDB$CHECK_CONSTRAINTS
	{
		put(tdgbl, rec_chk_constraint);

		if (!X.RDB$SCHEMA_NAME.NULL)
			PUT_TEXT(att_chk_schema_name, X.RDB$SCHEMA_NAME);

		PUT_TEXT(att_chk_constraint_name, X.RDB$CONSTRAINT_NAME);

		if (!X.RDB$TRIGGER_NAME.NULL)
			PUT_TEXT (att_chk_trigger_name, X.RDB$TRIGGER_NAME);
		put(tdgbl, att_end);
	}
	END_FOR
	ON_ERROR
		general_on_error();
	END_ERROR;

	MISC_release_request_silent(req_handle1);
}


void write_collations()
{
/**************************************
 *
 *	w r i t e _ c o l l a t i o n s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each user defined collation
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	if (tdgbl->runtimeODS >= DB_VERSION_DDL12)
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$COLLATIONS WITH X.RDB$SYSTEM_FLAG NE 1
		{
			put(tdgbl, rec_collation);

			if (!X.RDB$SCHEMA_NAME.NULL)
				PUT_TEXT(att_coll_schema_name, X.RDB$SCHEMA_NAME);

			PUT_TEXT (att_coll_name, X.RDB$COLLATION_NAME);
			put_int32 (att_coll_id, X.RDB$COLLATION_ID);
			put_int32 (att_coll_cs_id, X.RDB$CHARACTER_SET_ID);
			put_int32 (att_coll_attr, X.RDB$COLLATION_ATTRIBUTES);
			if (X.RDB$SYSTEM_FLAG)
				put_int32 (att_coll_sysflag, X.RDB$SYSTEM_FLAG);
			if (!X.RDB$DESCRIPTION.NULL)
				put_source_blob (att_coll_description, att_coll_description, X.RDB$DESCRIPTION);
			if (!X.RDB$FUNCTION_NAME.NULL)
				PUT_TEXT (att_coll_funct, X.RDB$FUNCTION_NAME);

			if (!X.RDB$BASE_COLLATION_NAME.NULL)
				PUT_TEXT(att_coll_base_collation_name, X.RDB$BASE_COLLATION_NAME);

			if (!X.RDB$SPECIFIC_ATTRIBUTES.NULL)
				put_source_blob (att_coll_specific_attr, att_coll_specific_attr, X.RDB$SPECIFIC_ATTRIBUTES);

			if (!X.RDB$SECURITY_CLASS.NULL)
				PUT_TEXT(att_coll_security_class, X.RDB$SECURITY_CLASS);
			if (!X.RDB$OWNER_NAME.NULL)
				PUT_TEXT(att_coll_owner_name, X.RDB$OWNER_NAME);

			put(tdgbl, att_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}
	else if (tdgbl->runtimeODS >= DB_VERSION_DDL11)
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$COLLATIONS WITH X.RDB$SYSTEM_FLAG MISSING OR X.RDB$SYSTEM_FLAG NE 1
			put(tdgbl, rec_collation);
			PUT_TEXT (att_coll_name, X.RDB$COLLATION_NAME);
			put_int32 (att_coll_id, X.RDB$COLLATION_ID);
			put_int32 (att_coll_cs_id, X.RDB$CHARACTER_SET_ID);
			put_int32 (att_coll_attr, X.RDB$COLLATION_ATTRIBUTES);
			if (X.RDB$SYSTEM_FLAG)
				put_int32 (att_coll_sysflag, X.RDB$SYSTEM_FLAG);
			if (!X.RDB$DESCRIPTION.NULL)
				put_source_blob (att_coll_description, att_coll_description, X.RDB$DESCRIPTION);
			if (!X.RDB$FUNCTION_NAME.NULL)
				PUT_TEXT (att_coll_funct, X.RDB$FUNCTION_NAME);
			if (!X.RDB$BASE_COLLATION_NAME.NULL)
				PUT_TEXT(att_coll_base_collation_name, X.RDB$BASE_COLLATION_NAME);
			if (!X.RDB$SPECIFIC_ATTRIBUTES.NULL)
				put_source_blob (att_coll_specific_attr, att_coll_specific_attr, X.RDB$SPECIFIC_ATTRIBUTES);
			put(tdgbl, att_end);
		END_FOR;
		ON_ERROR
			general_on_error();
		END_ERROR;
	}
	else
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$COLLATIONS WITH X.RDB$SYSTEM_FLAG MISSING OR X.RDB$SYSTEM_FLAG NE 1
			put(tdgbl, rec_collation);
			PUT_TEXT (att_coll_name, X.RDB$COLLATION_NAME);
			put_int32 (att_coll_id, X.RDB$COLLATION_ID);
			put_int32 (att_coll_cs_id, X.RDB$CHARACTER_SET_ID);
			put_int32 (att_coll_attr, X.RDB$COLLATION_ATTRIBUTES);
			if (X.RDB$SYSTEM_FLAG)
				put_int32 (att_coll_sysflag, X.RDB$SYSTEM_FLAG);
			if (!X.RDB$DESCRIPTION.NULL)
				put_source_blob (att_coll_description, att_coll_description, X.RDB$DESCRIPTION);
			if (!X.RDB$FUNCTION_NAME.NULL)
				PUT_TEXT (att_coll_funct, X.RDB$FUNCTION_NAME);
			put(tdgbl, att_end);
		END_FOR;
		ON_ERROR
			general_on_error();
		END_ERROR;
	}

	MISC_release_request_silent(req_handle1);
}


void write_database( const TEXT* dbb_file)
{
/**************************************
 *
 *	w r i t e _ d a t a b a s e
 *
 **************************************
 *
 * Functional description
 * 	write a physical database record and a
 *	logical database record in the burp file for
 *	the database itself.
 *
 **************************************/
	FbLocalStatus status_vector;
	UCHAR buffer[256];
	Firebird::IRequest* req_handle1 = nullptr;
	Firebird::IRequest* req_handle2 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	put(tdgbl, (UCHAR) rec_physical_db);

	DB->getInfo(&status_vector, sizeof(db_info_items), db_info_items,
						  sizeof(buffer), buffer);
	if (!status_vector.isSuccess())
	{
		BURP_error_redirect(&status_vector, 31);
		// msg 31 isc_database_info failed
	}

	USHORT page_size = 0, forced_writes, no_reserve, db_read_only, replica_mode;
 	ULONG sweep_interval, page_buffers;
 	USHORT length = 0;
	for (const UCHAR* d = buffer; *d != isc_info_end; d += length)
	{
		const UCHAR item = *d++;
		length = (USHORT) gds__vax_integer(d, 2);
		d += 2;
		switch (item)
		{
		case isc_info_end:
			break;

		case isc_info_page_size:
			page_size = (USHORT) gds__vax_integer(d, length);
			put_int32(att_page_size, page_size);
			break;

		case isc_info_sweep_interval:
			sweep_interval = gds__vax_integer(d, length);
			put_int32(att_sweep_interval, sweep_interval);
			break;

		case isc_info_forced_writes:
			forced_writes = (USHORT) gds__vax_integer(d, length);
			put_int32(att_forced_writes, forced_writes);
			break;

		case isc_info_no_reserve:
			if ((no_reserve = (USHORT) gds__vax_integer(d, length)) != 0)
				put_int32(att_no_reserve, no_reserve);
			break;

		case isc_info_set_page_buffers:
			if ((page_buffers = gds__vax_integer(d, length)) != 0)
				put_int32(att_page_buffers, page_buffers);
			break;

		case isc_info_error:	// old server does not understand new isc_info
			break;				// parameter and returns isc_info_error. skip it

		case isc_info_db_sql_dialect:
			tdgbl->gbl_dialect = (USHORT) gds__vax_integer(d, length);
			put_int32(att_SQL_dialect, tdgbl->gbl_dialect);
			break;

		case isc_info_db_read_only:
			if ((db_read_only = (USHORT) gds__vax_integer(d, length)) != 0)
				put_int32(att_db_read_only, db_read_only);
			break;

		case fb_info_replica_mode:
			if ((replica_mode = (USHORT) gds__vax_integer(d, length)) != 0)
				put_int32(att_replica_mode, replica_mode);
			break;

		default:
			BURP_error_redirect(&status_vector, 31);
			// msg 31 isc_database_info failed
			break;
		}
	}

	put_asciz(att_file_name, dbb_file);

	BURP_verbose(77, SafeArg() << dbb_file << page_size);
	// msg 77 database %s has a page size of %ld bytes.

	put(tdgbl, att_end);

	put(tdgbl, (UCHAR) rec_database);

	if (tdgbl->runtimeODS >= DB_VERSION_DDL12)
	{
		FOR (REQUEST_HANDLE req_handle1)
			D IN RDB$DATABASE
		{
			if (!D.RDB$SECURITY_CLASS.NULL)
				PUT_TEXT (att_database_security_class, D.RDB$SECURITY_CLASS);
			put_source_blob (att_database_description2, att_database_description, D.RDB$DESCRIPTION);
			if (!D.RDB$CHARACTER_SET_SCHEMA_NAME.NULL)
				PUT_TEXT (att_database_dfl_charset_schema_name, D.RDB$CHARACTER_SET_SCHEMA_NAME);
			if (!D.RDB$CHARACTER_SET_NAME.NULL)
				PUT_TEXT (att_database_dfl_charset, D.RDB$CHARACTER_SET_NAME);
			if (!D.RDB$LINGER.NULL)
				put_int32(att_database_linger, D.RDB$LINGER);
			if (!D.RDB$SQL_SECURITY.NULL)
				put_boolean(att_database_sql_security, D.RDB$SQL_SECURITY);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR;

		if (tdgbl->runtimeODS >= DB_VERSION_DDL13)
		{
			FOR (REQUEST_HANDLE req_handle2)
				PUB IN RDB$PUBLICATIONS
				WITH PUB.RDB$PUBLICATION_NAME EQ DEFAULT_PUBLICATION
			{
				fb_assert(PUB.RDB$SYSTEM_FLAG != 0);

				if (!PUB.RDB$ACTIVE_FLAG.NULL)
					put_boolean(att_default_pub_active, PUB.RDB$ACTIVE_FLAG);

				if (!PUB.RDB$AUTO_ENABLE.NULL)
					put_boolean(att_default_pub_auto_enable, PUB.RDB$AUTO_ENABLE);
			}
			END_FOR
			ON_ERROR
				general_on_error();
			END_ERROR
		}
	}
	else
	{
		FOR (REQUEST_HANDLE req_handle1)
			D IN RDB$DATABASE
			if (!D.RDB$SECURITY_CLASS.NULL)
				PUT_TEXT (att_database_security_class, D.RDB$SECURITY_CLASS);
			put_source_blob (att_database_description2, att_database_description, D.RDB$DESCRIPTION);
			if (!D.RDB$CHARACTER_SET_NAME.NULL)
				PUT_TEXT (att_database_dfl_charset, D.RDB$CHARACTER_SET_NAME);
		END_FOR;
		ON_ERROR
			general_on_error();
		END_ERROR;
	}

	MISC_release_request_silent(req_handle1);
	MISC_release_request_silent(req_handle2);

	put(tdgbl, att_end);
}


void write_exceptions()
{
/**************************************
 *
 *	w r i t e _ e x c e p t i o n s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each exception.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	if (tdgbl->runtimeODS >= DB_VERSION_DDL12)
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$EXCEPTIONS
			WITH X.RDB$SYSTEM_FLAG NE 1
		{
			QualifiedMetaString name;

			put(tdgbl, rec_exception);

			if (!X.RDB$SCHEMA_NAME.NULL)
			{
				PUT_TEXT(att_exception_schema_name, X.RDB$SCHEMA_NAME);
				name.schema = X.RDB$SCHEMA_NAME;
			}

			PUT_TEXT(att_exception_name, X.RDB$EXCEPTION_NAME);
			name.object = X.RDB$EXCEPTION_NAME;
			BURP_verbose(198, name.toQuotedString());
			// msg 198 writing exception %s

			PUT_MESSAGE(att_exception_msg, att_exception_msg2, X.RDB$MESSAGE);
			put_source_blob (att_exception_description2, att_exception_description, X.RDB$DESCRIPTION);

			if (!X.RDB$SECURITY_CLASS.NULL)
				PUT_TEXT(att_exception_security_class, X.RDB$SECURITY_CLASS);
			if (!X.RDB$OWNER_NAME.NULL)
				PUT_TEXT(att_exception_owner_name, X.RDB$OWNER_NAME);

			put(tdgbl, att_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR;
	}
	else
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$EXCEPTIONS
			WITH X.RDB$SYSTEM_FLAG MISSING OR X.RDB$SYSTEM_FLAG NE 1
		{
			QualifiedMetaString name;

			put(tdgbl, rec_exception);

			PUT_TEXT(att_exception_name, X.RDB$EXCEPTION_NAME);
			name.object = X.RDB$EXCEPTION_NAME;
			BURP_verbose(198, name.toQuotedString());
			// msg 198 writing exception %s

			PUT_MESSAGE(att_exception_msg, att_exception_msg2, X.RDB$MESSAGE);
			put_source_blob (att_exception_description2, att_exception_description, X.RDB$DESCRIPTION);
			put(tdgbl, att_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}

	MISC_release_request_silent(req_handle1);
}


void write_field_dimensions()
{
/**************************************
 *
 *	w r i t e _ f i e l d _ d i m e n s i o n s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each array field dimension.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	FOR (REQUEST_HANDLE req_handle1)
		X IN RDB$FIELD_DIMENSIONS
	{
		put(tdgbl, rec_field_dimensions);

		if (!X.RDB$SCHEMA_NAME.NULL)
			PUT_TEXT(att_field_schema_name, X.RDB$SCHEMA_NAME);

		PUT_TEXT (att_field_name, X.RDB$FIELD_NAME);
		put_int32 (att_field_dimensions, X.RDB$DIMENSION);
		put_int32 (att_field_range_low, X.RDB$LOWER_BOUND);
		put_int32 (att_field_range_high, X.RDB$UPPER_BOUND);
		put(tdgbl, att_end);
	}
	END_FOR
	ON_ERROR
		general_on_error();
	END_ERROR;

	MISC_release_request_silent(req_handle1);
}


void write_filters()
{
/**************************************
 *
 *	w r i t e _ f i l t e r s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each filter.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	FOR (REQUEST_HANDLE req_handle1)
		X IN RDB$FILTERS
		WITH X.RDB$SYSTEM_FLAG MISSING OR X.RDB$SYSTEM_FLAG NE 1
	{
		put(tdgbl, rec_filter);
		PUT_TEXT(att_filter_name, X.RDB$FUNCTION_NAME);
		BURP_verbose(145, MetaString(X.RDB$FUNCTION_NAME).toQuotedString());
		// msg 145 writing filter %s
		put_source_blob (att_filter_description2, att_filter_description, X.RDB$DESCRIPTION);
		PUT_TEXT (att_filter_module_name, X.RDB$MODULE_NAME);
		PUT_TEXT (att_filter_entrypoint, X.RDB$ENTRYPOINT);
		put_int32 (att_filter_input_sub_type, X.RDB$INPUT_SUB_TYPE);
		put_int32 (att_filter_output_sub_type, X.RDB$OUTPUT_SUB_TYPE);
		put(tdgbl, att_end);
	}
	END_FOR
	ON_ERROR
		general_on_error();
	END_ERROR

	MISC_release_request_silent(req_handle1);
}


void write_functions()
{
/**************************************
 *
 *	w r i t e _ f u n c t i o n s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each function.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	if (tdgbl->runtimeODS >= DB_VERSION_DDL12)
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$FUNCTIONS WITH X.RDB$SYSTEM_FLAG NE 1
		{
			QualifiedMetaString name;

			put(tdgbl, rec_function);

			if (!X.RDB$SCHEMA_NAME.NULL)
			{
				PUT_TEXT(att_function_schema_name, X.RDB$SCHEMA_NAME);
				name.schema = X.RDB$SCHEMA_NAME;
			}

			if (!X.RDB$PACKAGE_NAME.NULL)
			{
				PUT_TEXT(att_function_package_name, X.RDB$PACKAGE_NAME);
				name.package = X.RDB$PACKAGE_NAME;
			}

			PUT_TEXT(att_function_name, X.RDB$FUNCTION_NAME);
			name.object = X.RDB$FUNCTION_NAME;
			BURP_verbose(147, name.toQuotedString());
			// msg 147 writing function %.*s

			put_source_blob (att_function_description2, att_function_description, X.RDB$DESCRIPTION);

			if (!X.RDB$RETURN_ARGUMENT.NULL)
				put_int32 (att_function_return_arg, X.RDB$RETURN_ARGUMENT);

			put_int32 (att_function_type, X.RDB$FUNCTION_TYPE);
			PUT_TEXT (att_function_query_name, X.RDB$QUERY_NAME);

			if (!X.RDB$MODULE_NAME.NULL)
				PUT_TEXT(att_function_module_name, X.RDB$MODULE_NAME);
			if (!X.RDB$ENTRYPOINT.NULL)
				PUT_TEXT(att_function_entrypoint, X.RDB$ENTRYPOINT);

			if (!X.RDB$ENGINE_NAME.NULL)
				PUT_TEXT(att_function_engine_name, X.RDB$ENGINE_NAME);
			if (!X.RDB$PRIVATE_FLAG.NULL)
				put_int32(att_function_private_flag, X.RDB$PRIVATE_FLAG);
			if (!X.RDB$FUNCTION_BLR.NULL)
				put_blr_blob(att_function_blr, X.RDB$FUNCTION_BLR);
			if (!X.RDB$FUNCTION_SOURCE.NULL)
				put_source_blob(att_function_source, att_function_source, X.RDB$FUNCTION_SOURCE);
			if (!X.RDB$VALID_BLR.NULL)
				put_int32(att_function_valid_blr, X.RDB$VALID_BLR);
			if (!X.RDB$DEBUG_INFO.NULL)
				put_blr_blob(att_function_debug_info, X.RDB$DEBUG_INFO);
			if (!X.RDB$SECURITY_CLASS.NULL)
				PUT_TEXT(att_function_security_class, X.RDB$SECURITY_CLASS);
			if (!X.RDB$OWNER_NAME.NULL)
				PUT_TEXT(att_function_owner_name, X.RDB$OWNER_NAME);
			if (!X.RDB$LEGACY_FLAG.NULL)
				put_int32(att_function_legacy_flag, X.RDB$LEGACY_FLAG);
			if (!X.RDB$DETERMINISTIC_FLAG.NULL)
				put_int32(att_function_deterministic_flag, X.RDB$DETERMINISTIC_FLAG);
			if (!X.RDB$SQL_SECURITY.NULL)
				put_boolean(att_function_sql_security, X.RDB$SQL_SECURITY);

			put(tdgbl, att_end);

			write_function_args(name);

			put(tdgbl, rec_function_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR;
	}
	else
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$FUNCTIONS WITH X.RDB$SYSTEM_FLAG MISSING OR X.RDB$SYSTEM_FLAG NE 1
		{
			QualifiedMetaString name;

			put(tdgbl, rec_function);

			PUT_TEXT(att_function_name, X.RDB$FUNCTION_NAME);
			name.object = X.RDB$FUNCTION_NAME;
			BURP_verbose(147, name.toQuotedString());
			// msg 147 writing function %.*s

			put_source_blob (att_function_description2, att_function_description, X.RDB$DESCRIPTION);
			PUT_TEXT (att_function_module_name, X.RDB$MODULE_NAME);
			PUT_TEXT (att_function_entrypoint, X.RDB$ENTRYPOINT);

			if (!X.RDB$RETURN_ARGUMENT.NULL)
				put_int32 (att_function_return_arg, X.RDB$RETURN_ARGUMENT);

			put_int32 (att_function_type, X.RDB$FUNCTION_TYPE);
			PUT_TEXT (att_function_query_name, X.RDB$QUERY_NAME);
			put(tdgbl, att_end);
			write_function_args(name);

			put(tdgbl, rec_function_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}

	MISC_release_request_silent(req_handle1);
}


void write_function_args(const QualifiedMetaString& name)
{
/**************************************
 *
 *	w r i t e _ f u n c t i o n _ a r g s
 *
 **************************************
 *
 * Functional description
 * 	write all arguments for a function.
 *
 **************************************/
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	// if we have all capabilities, use the first request to get the
	// most performance out of the latest engine; if we don't
	// have one of the capabilities we must use the second set of
	// requests--this requires more code but it is well worth it
	// for the performance benefits, especially remotely--deej

	if (tdgbl->runtimeODS >= DB_VERSION_DDL12)
	{
		FOR (REQUEST_HANDLE tdgbl->handles_write_function_args_req_handle1)
			X IN RDB$FUNCTION_ARGUMENTS
			WITH X.RDB$SCHEMA_NAME EQUIV NULLIF(name.schema.c_str(), '') AND
				 X.RDB$FUNCTION_NAME EQ name.object.c_str() AND
				 X.RDB$PACKAGE_NAME EQUIV NULLIF(name.package.c_str(), '')
		{
			put(tdgbl, rec_function_arg);

			if (name.schema.hasData())
				put_text(att_functionarg_schema_name, name.schema);

			if (name.package.hasData())
				put_text(att_functionarg_package_name, name.package);

			put_text(att_functionarg_name, name.object);
			BURP_verbose(141, name.toQuotedString());
			// msg 141 writing argument for function %s

			if (!X.RDB$ARGUMENT_POSITION.NULL)
				put_int32 (att_functionarg_position, X.RDB$ARGUMENT_POSITION);

			put_int32 (att_functionarg_passing_mechanism, X.RDB$MECHANISM);
			put_int32 (att_functionarg_field_type, X.RDB$FIELD_TYPE);
			put_int32 (att_functionarg_field_scale, X.RDB$FIELD_SCALE);
			put_int32 (att_functionarg_field_length, X.RDB$FIELD_LENGTH);
			put_int32 (att_functionarg_field_sub_type, X.RDB$FIELD_SUB_TYPE);
			if (!X.RDB$CHARACTER_SET_ID.NULL)
				put_int32 (att_functionarg_character_set, X.RDB$CHARACTER_SET_ID);

			if (!X.RDB$FIELD_PRECISION.NULL)
				put_int32 (att_functionarg_field_precision, X.RDB$FIELD_PRECISION);

			if (!X.RDB$ARGUMENT_NAME.NULL)
				PUT_TEXT(att_functionarg_arg_name, X.RDB$ARGUMENT_NAME);
			if (!X.RDB$FIELD_SOURCE_SCHEMA_NAME.NULL)
				PUT_TEXT(att_functionarg_field_source_schema_name, X.RDB$FIELD_SOURCE_SCHEMA_NAME);
			if (!X.RDB$FIELD_SOURCE.NULL)
				PUT_TEXT(att_functionarg_field_source, X.RDB$FIELD_SOURCE);
			if (!X.RDB$DEFAULT_VALUE.NULL)
				put_blr_blob(att_functionarg_default_value, X.RDB$DEFAULT_VALUE);
			if (!X.RDB$DEFAULT_SOURCE.NULL)
				put_source_blob(att_functionarg_default_source, att_functionarg_default_source,
								X.RDB$DEFAULT_SOURCE);
			if (!X.RDB$COLLATION_ID.NULL)
				put_int32(att_functionarg_collation_id, X.RDB$COLLATION_ID);
			if (!X.RDB$NULL_FLAG.NULL)
				put_int32(att_functionarg_null_flag, X.RDB$NULL_FLAG);
			if (!X.RDB$ARGUMENT_MECHANISM.NULL)
				put_int32(att_functionarg_type_mechanism, X.RDB$ARGUMENT_MECHANISM);
			if (!X.RDB$FIELD_NAME.NULL)
				PUT_TEXT(att_functionarg_field_name, X.RDB$FIELD_NAME);
			if (!X.RDB$RELATION_SCHEMA_NAME.NULL)
				PUT_TEXT(att_functionarg_relation_schema_name, X.RDB$RELATION_SCHEMA_NAME);
			if (!X.RDB$RELATION_NAME.NULL)
				PUT_TEXT(att_functionarg_relation_name, X.RDB$RELATION_NAME);
			if (!X.RDB$DESCRIPTION.NULL)
				put_source_blob(att_functionarg_description, att_functionarg_description, X.RDB$DESCRIPTION);

			put(tdgbl, att_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR;
	}
	else if (tdgbl->runtimeODS >= DB_VERSION_DDL10)
	{
		FOR (REQUEST_HANDLE tdgbl->handles_write_function_args_req_handle1)
			X IN RDB$FUNCTION_ARGUMENTS WITH
			X.RDB$FUNCTION_NAME EQ name.object.c_str()
		{
			put(tdgbl, rec_function_arg);

			put_text(att_functionarg_name, name.object);
			BURP_verbose(141, name.toQuotedString());
			// msg 141 writing argument for function %s

			if (!X.RDB$ARGUMENT_POSITION.NULL)
				put_int32 (att_functionarg_position, X.RDB$ARGUMENT_POSITION);

			put_int32 (att_functionarg_passing_mechanism, X.RDB$MECHANISM);
			put_int32 (att_functionarg_field_type, X.RDB$FIELD_TYPE);
			put_int32 (att_functionarg_field_scale, X.RDB$FIELD_SCALE);
			put_int32 (att_functionarg_field_length, X.RDB$FIELD_LENGTH);
			put_int32 (att_functionarg_field_sub_type, X.RDB$FIELD_SUB_TYPE);
			if (!X.RDB$CHARACTER_SET_ID.NULL)
				put_int32 (att_functionarg_character_set, X.RDB$CHARACTER_SET_ID);

			if (!X.RDB$FIELD_PRECISION.NULL)
				put_int32 (att_functionarg_field_precision, X.RDB$FIELD_PRECISION);
			put(tdgbl, att_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}
	else
	{
		FOR (REQUEST_HANDLE tdgbl->handles_write_function_args_req_handle1)
			X IN RDB$FUNCTION_ARGUMENTS WITH
			X.RDB$FUNCTION_NAME EQ name.object.c_str()
		{
			put(tdgbl, rec_function_arg);

			put_text(att_functionarg_name, name.object);
			BURP_verbose(141, name.toQuotedString());
			// msg 141 writing argument for function %s

			if (!X.RDB$ARGUMENT_POSITION.NULL)
				put_int32 (att_functionarg_position, X.RDB$ARGUMENT_POSITION);

			put_int32 (att_functionarg_passing_mechanism, X.RDB$MECHANISM);
			put_int32 (att_functionarg_field_type, X.RDB$FIELD_TYPE);
			put_int32 (att_functionarg_field_scale, X.RDB$FIELD_SCALE);
			put_int32 (att_functionarg_field_length, X.RDB$FIELD_LENGTH);
			put_int32 (att_functionarg_field_sub_type, X.RDB$FIELD_SUB_TYPE);

			if (!X.RDB$CHARACTER_SET_ID.NULL)
				put_int32 (att_functionarg_character_set, X.RDB$CHARACTER_SET_ID);
			// Note that DB_VERSION_DDL10 canNOT be set if we're in this
			// "else" branch.  Hence there is no need to test that
			// bit and store the RDB$FIELD_PRECISION.

			put(tdgbl, att_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}
}


void write_generators()
{
/**************************************
 *
 *	w r i t e _ g e n e r a t o r s
 *
 **************************************
 *
 * Functional description
 *	Write any defined generators.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	if (tdgbl->runtimeODS >= DB_VERSION_DDL12)
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$GENERATORS
			WITH X.RDB$SYSTEM_FLAG NE 1
		{
			QualifiedMetaString name;

			put(tdgbl, rec_generator);

			if (!X.RDB$SCHEMA_NAME.NULL)
			{
				PUT_TEXT(att_gen_schema_name, X.RDB$SCHEMA_NAME);
				name.schema = X.RDB$SCHEMA_NAME;
			}

			PUT_TEXT(att_gen_generator, X.RDB$GENERATOR_NAME);
			name.object = X.RDB$GENERATOR_NAME;

			SINT64 value = 0;
			if (!tdgbl->gbl_sw_meta)
			{
				value = get_gen_id(name);
				put_int64(att_gen_value_int64, value);
			}

			BURP_verbose(165, SafeArg() << name.toQuotedString().c_str() << value);
			// msg 165 writing generator %s value %ld

			if (!tdgbl->gbl_sw_meta)
				put_int64 (att_gen_value_int64, value);

			if (!X.RDB$DESCRIPTION.NULL)
				put_source_blob (att_gen_description, att_gen_description, X.RDB$DESCRIPTION);

			if (X.RDB$SYSTEM_FLAG)
				put_int32(att_gen_sysflag, X.RDB$SYSTEM_FLAG);

			if (!X.RDB$SECURITY_CLASS.NULL)
				PUT_TEXT(att_gen_security_class, X.RDB$SECURITY_CLASS);
			if (!X.RDB$OWNER_NAME.NULL)
				PUT_TEXT(att_gen_owner_name, X.RDB$OWNER_NAME);
			if (!X.RDB$INITIAL_VALUE.NULL)
				put_int64(att_gen_init_val, X.RDB$INITIAL_VALUE);

			put_int32(att_gen_id_increment, X.RDB$GENERATOR_INCREMENT);

			put(tdgbl, att_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR;
	}
	else if (tdgbl->runtimeODS >= DB_VERSION_DDL11)
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$GENERATORS
			WITH X.RDB$SYSTEM_FLAG MISSING OR X.RDB$SYSTEM_FLAG NE 1
		{
			QualifiedMetaString name;

			put(tdgbl, rec_generator);
			PUT_TEXT(att_gen_generator, X.RDB$GENERATOR_NAME);
			name.object = X.RDB$GENERATOR_NAME;

			SINT64 value = 0;
			if (!tdgbl->gbl_sw_meta)
			{
				value = get_gen_id(name);
				put_int64(att_gen_value_int64, value);
			}
			if (!X.RDB$DESCRIPTION.NULL) {
				put_source_blob (att_gen_description, att_gen_description, X.RDB$DESCRIPTION);
			}
			put(tdgbl, att_end);

			BURP_verbose(165, SafeArg() << name.toQuotedString().c_str() << value);
			// msg 165 writing generator %s value %ld
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}
	else
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$GENERATORS
			WITH X.RDB$SYSTEM_FLAG MISSING OR X.RDB$SYSTEM_FLAG NE 1
		{
			QualifiedMetaString name;

			put(tdgbl, rec_generator);
			PUT_TEXT(att_gen_generator, X.RDB$GENERATOR_NAME);
			name.object = X.RDB$GENERATOR_NAME;

			SINT64 value = 0;
			if (!tdgbl->gbl_sw_meta)
			{
				value = get_gen_id(name);
				put_int64(att_gen_value_int64, value);
			}
			put(tdgbl, att_end);

			BURP_verbose(165, SafeArg() << name.toQuotedString().c_str() << value);
			// msg 165 writing generator %s value %ld
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}

	MISC_release_request_silent(req_handle1);
}


void write_global_fields()
{
/**************************************
 *
 *	w r i t e _ g l o b a l _ f i e l d s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each global field.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	// if we have all capabilities, use the first request to get the
	// most performance out of the latest engine; if we don't
	// have one of the capabilities we must use the second set of
	// requests--this requires more code but it is well worth it
	// for the performance benefits, especially remotely--deej

	if (tdgbl->runtimeODS >= DB_VERSION_DDL12)
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$FIELDS WITH
			X.RDB$SYSTEM_FLAG NE 1
		{
			QualifiedMetaString name;

			put(tdgbl, rec_global_field);

			if (!X.RDB$SCHEMA_NAME.NULL)
			{
				PUT_TEXT(att_field_schema_name, X.RDB$SCHEMA_NAME);
				name.schema = X.RDB$SCHEMA_NAME;
			}

			PUT_TEXT(att_field_name, X.RDB$FIELD_NAME);
			name.object = X.RDB$FIELD_NAME;

			BURP_verbose(149, name.toQuotedString());

			// msg 149  writing global field %.*s
			if (!X.RDB$QUERY_NAME.NULL && X.RDB$QUERY_NAME [0] != ' ')
				PUT_TEXT (att_field_query_name, X.RDB$QUERY_NAME);
			if (!X.RDB$EDIT_STRING.NULL && X.RDB$EDIT_STRING [0] != ' ')
				PUT_TEXT (att_field_edit_string, X.RDB$EDIT_STRING);
			put_source_blob (att_field_query_header, att_field_query_header, X.RDB$QUERY_HEADER);
			put_int32 (att_field_type, X.RDB$FIELD_TYPE);
			put_int32 (att_field_length, X.RDB$FIELD_LENGTH);
			put_int32 (att_field_sub_type, X.RDB$FIELD_SUB_TYPE);
			put_int32 (att_field_scale, X.RDB$FIELD_SCALE);
			put_blr_blob (att_field_missing_value, X.RDB$MISSING_VALUE);
			put_blr_blob (att_field_default_value, X.RDB$DEFAULT_VALUE);
			put_blr_blob (att_field_validation_blr, X.RDB$VALIDATION_BLR);
			put_source_blob(att_field_validation_source2, att_field_validation_source,
							X.RDB$VALIDATION_SOURCE);
			put_blr_blob (att_field_computed_blr, X.RDB$COMPUTED_BLR);
			put_source_blob(att_field_computed_source2, att_field_computed_source,
							X.RDB$COMPUTED_SOURCE);
			if (X.RDB$SEGMENT_LENGTH)
				put_int32 (att_field_segment_length, X.RDB$SEGMENT_LENGTH);
			if (X.RDB$SYSTEM_FLAG)
				put_int32 (att_field_system_flag, X.RDB$SYSTEM_FLAG);
			put_source_blob (att_field_description2, att_field_description, X.RDB$DESCRIPTION);

			if (X.RDB$EXTERNAL_LENGTH)
				put_int32 (att_field_external_length, X.RDB$EXTERNAL_LENGTH);
			if (X.RDB$EXTERNAL_TYPE)
				put_int32 (att_field_external_type, X.RDB$EXTERNAL_TYPE);
			if (X.RDB$EXTERNAL_SCALE)
				put_int32 (att_field_external_scale, X.RDB$EXTERNAL_SCALE);
			if (X.RDB$DIMENSIONS)
				put_int32 (att_field_dimensions, X.RDB$DIMENSIONS);
			if (!X.RDB$NULL_FLAG.NULL)
				put_int32 (att_field_null_flag, X.RDB$NULL_FLAG);
			if (!X.RDB$CHARACTER_LENGTH.NULL)
				put_int32 (att_field_character_length, X.RDB$CHARACTER_LENGTH);
			if (!X.RDB$DEFAULT_SOURCE.NULL)
				put_source_blob(att_field_default_source, att_field_default_source,
								X.RDB$DEFAULT_SOURCE);
			if (!X.RDB$MISSING_SOURCE.NULL)
				put_source_blob(att_field_missing_source, att_field_missing_source,
								X.RDB$MISSING_SOURCE);
			if (!X.RDB$CHARACTER_SET_ID.NULL)
				put_int32 (att_field_character_set, X.RDB$CHARACTER_SET_ID);
			if (!X.RDB$COLLATION_ID.NULL)
				put_int32 (att_field_collation_id, X.RDB$COLLATION_ID);
			if (!X.RDB$FIELD_PRECISION.NULL)
				put_int32 (att_field_precision, X.RDB$FIELD_PRECISION);

			if (!X.RDB$SECURITY_CLASS.NULL)
				PUT_TEXT(att_field_security_class, X.RDB$SECURITY_CLASS);
			if (!X.RDB$OWNER_NAME.NULL)
				PUT_TEXT(att_field_owner_name, X.RDB$OWNER_NAME);

			put(tdgbl, att_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR;
	}
	else if (tdgbl->runtimeODS >= DB_VERSION_DDL10)
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$FIELDS WITH
			X.RDB$SYSTEM_FLAG NE 1 OR
			X.RDB$SYSTEM_FLAG MISSING
		{
			QualifiedMetaString name;

			put(tdgbl, rec_global_field);

			PUT_TEXT(att_field_name, X.RDB$FIELD_NAME);
			name.object = X.RDB$FIELD_NAME;

			BURP_verbose(149, name.toQuotedString());
			// msg 149  writing global field %.*s

			if (!X.RDB$QUERY_NAME.NULL && X.RDB$QUERY_NAME [0] != ' ')
				PUT_TEXT (att_field_query_name, X.RDB$QUERY_NAME);
			if (!X.RDB$EDIT_STRING.NULL && X.RDB$EDIT_STRING [0] != ' ')
				PUT_TEXT (att_field_edit_string, X.RDB$EDIT_STRING);
			put_source_blob (att_field_query_header, att_field_query_header, X.RDB$QUERY_HEADER);
			put_int32 (att_field_type, X.RDB$FIELD_TYPE);
			put_int32 (att_field_length, X.RDB$FIELD_LENGTH);
			put_int32 (att_field_sub_type, X.RDB$FIELD_SUB_TYPE);
			put_int32 (att_field_scale, X.RDB$FIELD_SCALE);
			put_blr_blob (att_field_missing_value, X.RDB$MISSING_VALUE);
			put_blr_blob (att_field_default_value, X.RDB$DEFAULT_VALUE);
			put_blr_blob (att_field_validation_blr, X.RDB$VALIDATION_BLR);
			put_source_blob(att_field_validation_source2, att_field_validation_source,
							X.RDB$VALIDATION_SOURCE);
			put_blr_blob (att_field_computed_blr, X.RDB$COMPUTED_BLR);
			put_source_blob(att_field_computed_source2, att_field_computed_source,
							X.RDB$COMPUTED_SOURCE);
			if (X.RDB$SEGMENT_LENGTH)
				put_int32 (att_field_segment_length, X.RDB$SEGMENT_LENGTH);
			if (X.RDB$SYSTEM_FLAG)
				put_int32 (att_field_system_flag, X.RDB$SYSTEM_FLAG);
			put_source_blob (att_field_description2, att_field_description, X.RDB$DESCRIPTION);

			if (X.RDB$EXTERNAL_LENGTH)
				put_int32 (att_field_external_length, X.RDB$EXTERNAL_LENGTH);
			if (X.RDB$EXTERNAL_TYPE)
				put_int32 (att_field_external_type, X.RDB$EXTERNAL_TYPE);
			if (X.RDB$EXTERNAL_SCALE)
				put_int32 (att_field_external_scale, X.RDB$EXTERNAL_SCALE);
			if (X.RDB$DIMENSIONS)
				put_int32 (att_field_dimensions, X.RDB$DIMENSIONS);
			if (!X.RDB$NULL_FLAG.NULL)
				put_int32 (att_field_null_flag, X.RDB$NULL_FLAG);
			if (!X.RDB$CHARACTER_LENGTH.NULL)
				put_int32 (att_field_character_length, X.RDB$CHARACTER_LENGTH);
			if (!X.RDB$DEFAULT_SOURCE.NULL)
				put_source_blob(att_field_default_source, att_field_default_source,
								X.RDB$DEFAULT_SOURCE);
			if (!X.RDB$MISSING_SOURCE.NULL)
				put_source_blob(att_field_missing_source, att_field_missing_source,
								X.RDB$MISSING_SOURCE);
			if (!X.RDB$CHARACTER_SET_ID.NULL)
				put_int32 (att_field_character_set, X.RDB$CHARACTER_SET_ID);
			if (!X.RDB$COLLATION_ID.NULL)
				put_int32 (att_field_collation_id, X.RDB$COLLATION_ID);

			if (!X.RDB$FIELD_PRECISION.NULL)
				put_int32 (att_field_precision, X.RDB$FIELD_PRECISION);

			put(tdgbl, att_end);
		}
		END_FOR;
		ON_ERROR
			general_on_error();
		END_ERROR;
	}
	else
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$FIELDS WITH
			X.RDB$SYSTEM_FLAG NE 1 OR
			X.RDB$SYSTEM_FLAG MISSING
		{
			QualifiedMetaString name;

			put(tdgbl, rec_global_field);

			PUT_TEXT(att_field_name, X.RDB$FIELD_NAME);
			name.object = X.RDB$FIELD_NAME;

			BURP_verbose(149, name.toQuotedString());
			// msg 149  writing global field %.*s

			if (!X.RDB$QUERY_NAME.NULL && X.RDB$QUERY_NAME [0] != ' ')
				PUT_TEXT (att_field_query_name, X.RDB$QUERY_NAME);
			if (!X.RDB$EDIT_STRING.NULL && X.RDB$EDIT_STRING [0] != ' ')
				PUT_TEXT (att_field_edit_string, X.RDB$EDIT_STRING);
			put_source_blob (att_field_query_header, att_field_query_header, X.RDB$QUERY_HEADER);
			put_int32 (att_field_type, X.RDB$FIELD_TYPE);
			put_int32 (att_field_length, X.RDB$FIELD_LENGTH);
			put_int32 (att_field_sub_type, X.RDB$FIELD_SUB_TYPE);
			put_int32 (att_field_scale, X.RDB$FIELD_SCALE);
			put_blr_blob (att_field_missing_value, X.RDB$MISSING_VALUE);
			put_blr_blob (att_field_default_value, X.RDB$DEFAULT_VALUE);
			put_blr_blob (att_field_validation_blr, X.RDB$VALIDATION_BLR);
			put_source_blob(att_field_validation_source2, att_field_validation_source,
							X.RDB$VALIDATION_SOURCE);
			put_blr_blob (att_field_computed_blr, X.RDB$COMPUTED_BLR);
			put_source_blob (att_field_computed_source2, att_field_computed_source,
				X.RDB$COMPUTED_SOURCE);
			if (X.RDB$SEGMENT_LENGTH)
				put_int32 (att_field_segment_length, X.RDB$SEGMENT_LENGTH);
			if (X.RDB$SYSTEM_FLAG)
				put_int32 (att_field_system_flag, X.RDB$SYSTEM_FLAG);
			put_source_blob (att_field_description2, att_field_description, X.RDB$DESCRIPTION);
			if (X.RDB$EXTERNAL_LENGTH)
				put_int32 (att_field_external_length, X.RDB$EXTERNAL_LENGTH);
			if (X.RDB$EXTERNAL_TYPE)
				put_int32 (att_field_external_type, X.RDB$EXTERNAL_TYPE);
			if (X.RDB$EXTERNAL_SCALE)
				put_int32 (att_field_external_scale, X.RDB$EXTERNAL_SCALE);
			if (X.RDB$DIMENSIONS)
				put_int32 (att_field_dimensions, X.RDB$DIMENSIONS);
			if (!X.RDB$NULL_FLAG.NULL)
				put_int32 (att_field_null_flag, X.RDB$NULL_FLAG);
			if (!X.RDB$CHARACTER_LENGTH.NULL)
				put_int32 (att_field_character_length, X.RDB$CHARACTER_LENGTH);
			if (!X.RDB$DEFAULT_SOURCE.NULL)
				put_source_blob(att_field_default_source, att_field_default_source,
								X.RDB$DEFAULT_SOURCE);
			if (!X.RDB$MISSING_SOURCE.NULL)
				put_source_blob(att_field_missing_source, att_field_missing_source,
								X.RDB$MISSING_SOURCE);
			if (!X.RDB$CHARACTER_SET_ID.NULL)
				put_int32 (att_field_character_set, X.RDB$CHARACTER_SET_ID);
			if (!X.RDB$COLLATION_ID.NULL)
				put_int32 (att_field_collation_id, X.RDB$COLLATION_ID);

			put(tdgbl, att_end);
		}
		END_FOR;
		ON_ERROR
			general_on_error();
		END_ERROR;
	}

	MISC_release_request_silent(req_handle1);
}


void write_packages()
{
/**************************************
 *
 *	w r i t e _ p a c k a g e s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each package.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	// This code is for DDL12 onwards, so no need to check for null sysflag.
	FOR (REQUEST_HANDLE req_handle1)
		X IN RDB$PACKAGES
		WITH X.RDB$SYSTEM_FLAG NE 1
	{
		QualifiedMetaString name;

		put(tdgbl, rec_package);

		if (!X.RDB$SCHEMA_NAME.NULL)
		{
			PUT_TEXT(att_package_schema_name, X.RDB$SCHEMA_NAME);
			name.schema = X.RDB$SCHEMA_NAME;
		}

		PUT_TEXT(att_package_name, X.RDB$PACKAGE_NAME);
		name.object = X.RDB$PACKAGE_NAME;

		BURP_verbose(335, name.toQuotedString());	// msg 335 writing package @1

		if (!X.RDB$PACKAGE_HEADER_SOURCE.NULL)
		{
			put_source_blob(att_package_header_source, att_package_header_source,
				X.RDB$PACKAGE_HEADER_SOURCE);
		}

		if (!X.RDB$PACKAGE_BODY_SOURCE.NULL)
		{
			put_source_blob(att_package_body_source, att_package_body_source,
				X.RDB$PACKAGE_BODY_SOURCE);
		}

		if (!X.RDB$VALID_BODY_FLAG.NULL)
			put_int32(att_package_valid_body_flag, X.RDB$VALID_BODY_FLAG);

		if (!X.RDB$SECURITY_CLASS.NULL)
			PUT_TEXT(att_package_security_class, X.RDB$SECURITY_CLASS);
		if (!X.RDB$OWNER_NAME.NULL)
			PUT_TEXT(att_package_owner_name, X.RDB$OWNER_NAME);

		if (!X.RDB$DESCRIPTION.NULL)
			put_source_blob(att_package_description, att_package_description, X.RDB$DESCRIPTION);

		if (!X.RDB$SQL_SECURITY.NULL)
			put_boolean(att_package_sql_security, X.RDB$SQL_SECURITY);

		put(tdgbl, att_end);
	}
	END_FOR
	ON_ERROR
		general_on_error();
	END_ERROR

	MISC_release_request_silent(req_handle1);
}


void write_procedures()
{
/**************************************
 *
 *	w r i t e _ p r o c e d u r e s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each stored procedure.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	if (tdgbl->runtimeODS >= DB_VERSION_DDL11_1)
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$PROCEDURES
			WITH X.RDB$SYSTEM_FLAG MISSING OR X.RDB$SYSTEM_FLAG NE 1
		{
			QualifiedMetaString name;

			put(tdgbl, rec_procedure);

			if (!X.RDB$SCHEMA_NAME.NULL)
			{
				PUT_TEXT(att_procedure_schema_name, X.RDB$SCHEMA_NAME);
				name.schema = X.RDB$SCHEMA_NAME;
			}

			if (!X.RDB$PACKAGE_NAME.NULL)
			{
				PUT_TEXT(att_procedure_package_name, X.RDB$PACKAGE_NAME);
				name.package = X.RDB$PACKAGE_NAME;
			}

			PUT_TEXT(att_procedure_name, X.RDB$PROCEDURE_NAME);
			name.object = X.RDB$PROCEDURE_NAME;

			BURP_verbose(193, name.toQuotedString());
			// msg 193 writing stored procedure %.*s

			put_int32 (att_procedure_inputs, X.RDB$PROCEDURE_INPUTS);
			put_int32 (att_procedure_outputs, X.RDB$PROCEDURE_OUTPUTS);
			put_source_blob(att_procedure_description2, att_procedure_description, X.RDB$DESCRIPTION);
			put_source_blob (att_procedure_source2, att_procedure_source, X.RDB$PROCEDURE_SOURCE);

			if (!X.RDB$PROCEDURE_BLR.NULL)
				put_blr_blob (att_procedure_blr, X.RDB$PROCEDURE_BLR);

			if (!X.RDB$SECURITY_CLASS.NULL)
				PUT_TEXT (att_procedure_security_class, X.RDB$SECURITY_CLASS);
			if (!X.RDB$OWNER_NAME.NULL)
				PUT_TEXT (att_procedure_owner_name, X.RDB$OWNER_NAME);
			if (!X.RDB$PROCEDURE_TYPE.NULL)
				put_int32 (att_procedure_type, X.RDB$PROCEDURE_TYPE);
			if (!X.RDB$VALID_BLR.NULL)
				put_int32 (att_procedure_valid_blr, X.RDB$VALID_BLR);
			if (!X.RDB$DEBUG_INFO.NULL)
				put_blr_blob (att_procedure_debug_info, X.RDB$DEBUG_INFO);

			if (!X.RDB$ENGINE_NAME.NULL)
				PUT_TEXT(att_procedure_engine_name, X.RDB$ENGINE_NAME);

			if (!X.RDB$ENTRYPOINT.NULL)
				PUT_TEXT(att_procedure_entrypoint, X.RDB$ENTRYPOINT);

			if (!X.RDB$PRIVATE_FLAG.NULL)
				put_int32(att_procedure_private_flag, X.RDB$PRIVATE_FLAG);

			if (!X.RDB$SQL_SECURITY.NULL)
				put_boolean(att_procedure_sql_security, X.RDB$SQL_SECURITY);

			put(tdgbl, att_end);

			write_procedure_prms(name);
			put(tdgbl, rec_procedure_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}
	else
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$PROCEDURES
			WITH X.RDB$SYSTEM_FLAG MISSING OR X.RDB$SYSTEM_FLAG NE 1
		{
			QualifiedMetaString name;

			put(tdgbl, rec_procedure);

			PUT_TEXT(att_procedure_name, X.RDB$PROCEDURE_NAME);
			name.object = X.RDB$PROCEDURE_NAME;
			BURP_verbose(193, name.toQuotedString());
			// msg 193 writing stored procedure %.*s

			put_int32 (att_procedure_inputs, X.RDB$PROCEDURE_INPUTS);
			put_int32 (att_procedure_outputs, X.RDB$PROCEDURE_OUTPUTS);
			put_source_blob (att_procedure_description2, att_procedure_description, X.RDB$DESCRIPTION);
			put_source_blob (att_procedure_source2, att_procedure_source, X.RDB$PROCEDURE_SOURCE);
			put_blr_blob (att_procedure_blr, X.RDB$PROCEDURE_BLR);
			if (!X.RDB$SECURITY_CLASS.NULL)
				PUT_TEXT (att_procedure_security_class, X.RDB$SECURITY_CLASS);
			if (!X.RDB$SECURITY_CLASS.NULL)
				PUT_TEXT (att_procedure_owner_name, X.RDB$OWNER_NAME);
			put(tdgbl, att_end);

			write_procedure_prms(name);
			put(tdgbl, rec_procedure_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}

	MISC_release_request_silent(req_handle1);
}


void write_procedure_prms(const QualifiedMetaString& name)
{
/**************************************
 *
 *	w r i t e _ p r o c e d u r e _ p r m s
 *
 **************************************
 *
 * Functional description
 * 	write all parameters of a stored procedure.
 *
 **************************************/
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	if (tdgbl->runtimeODS >= DB_VERSION_DDL11_1)
	{
		FOR (REQUEST_HANDLE tdgbl->handles_write_procedure_prms_req_handle1)
			X IN RDB$PROCEDURE_PARAMETERS
			WITH X.RDB$SCHEMA_NAME EQUIV NULLIF(name.schema.c_str(), '') AND
				 X.RDB$PROCEDURE_NAME EQ name.object.c_str() AND
				 X.RDB$PACKAGE_NAME EQUIV NULLIF(name.package.c_str(), '')
		{
			put(tdgbl, rec_procedure_prm);

			PUT_TEXT(att_procedureprm_name, X.RDB$PARAMETER_NAME);
			BURP_verbose(194, MetaString(X.RDB$PARAMETER_NAME).toQuotedString());
			// msg 194 writing parameter %s for stored procedure

			put_int32 (att_procedureprm_number, X.RDB$PARAMETER_NUMBER);
			put_int32 (att_procedureprm_type, X.RDB$PARAMETER_type);

			if (!X.RDB$FIELD_SOURCE_SCHEMA_NAME.NULL)
				PUT_TEXT(att_procedureprm_field_source_schema_name, X.RDB$FIELD_SOURCE_SCHEMA_NAME);

			PUT_TEXT(att_procedureprm_field_source, X.RDB$FIELD_SOURCE);
			put_source_blob(att_procedureprm_description2, att_procedureprm_description,
							X.RDB$DESCRIPTION);
			put_blr_blob (att_procedureprm_default_value, X.RDB$DEFAULT_VALUE);
			put_source_blob(att_procedureprm_default_source, att_procedureprm_default_source,
							X.RDB$DEFAULT_SOURCE);
			if (!X.RDB$COLLATION_ID.NULL)
				put_int32 (att_procedureprm_collation_id, X.RDB$COLLATION_ID);
			if (!X.RDB$NULL_FLAG.NULL)
				put_int32 (att_procedureprm_null_flag, X.RDB$NULL_FLAG);
			if (!X.RDB$PARAMETER_MECHANISM.NULL)
				put_int32 (att_procedureprm_mechanism, X.RDB$PARAMETER_MECHANISM);

			// DB_VERSION_DDL11_2
			if (!X.RDB$FIELD_NAME.NULL)
				PUT_TEXT(att_procedureprm_field_name, X.RDB$FIELD_NAME);

			if (!X.RDB$RELATION_SCHEMA_NAME.NULL)
				PUT_TEXT(att_procedureprm_relation_schema_name, X.RDB$RELATION_SCHEMA_NAME);

			if (!X.RDB$RELATION_NAME.NULL)
				PUT_TEXT(att_procedureprm_relation_name, X.RDB$RELATION_NAME);

			put(tdgbl, att_end);
		}
		END_FOR;
		ON_ERROR
			general_on_error();
		END_ERROR
	}
	else
	{
		FOR (REQUEST_HANDLE tdgbl->handles_write_procedure_prms_req_handle1)
			X IN RDB$PROCEDURE_PARAMETERS WITH X.RDB$PROCEDURE_NAME EQ name.object.c_str()
		{
			put(tdgbl, rec_procedure_prm);

			PUT_TEXT(att_procedureprm_name, X.RDB$PARAMETER_NAME);
			BURP_verbose(194, MetaString(X.RDB$PARAMETER_NAME).toQuotedString());
			// msg 194 writing parameter %s for stored procedure

			put_int32 (att_procedureprm_number, X.RDB$PARAMETER_NUMBER);
			put_int32 (att_procedureprm_type, X.RDB$PARAMETER_type);
			PUT_TEXT (att_procedureprm_field_source, X.RDB$FIELD_SOURCE);
			put_source_blob(att_procedureprm_description2, att_procedureprm_description,
							X.RDB$DESCRIPTION);
			put(tdgbl, att_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}
}


void write_publications()
{
/**************************************
 *
 *	w r i t e _ p u b l i c a t i o n s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each publication.
 *
 **************************************/
	Firebird::IRequest* req_handle = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	FOR (REQUEST_HANDLE req_handle)
		X IN RDB$PUBLICATIONS
		WITH X.RDB$SYSTEM_FLAG NE 1
	{
		put(tdgbl, rec_publication);

		PUT_TEXT(att_pub_name, X.RDB$PUBLICATION_NAME);

		BURP_verbose(397, MetaString(X.RDB$PUBLICATION_NAME).toQuotedString());
		// msg 397 writing publication %s

		if (!X.RDB$OWNER_NAME.NULL)
			PUT_TEXT(att_pub_owner_name, X.RDB$OWNER_NAME);

		if (!X.RDB$ACTIVE_FLAG.NULL)
			put_int32(att_pub_active_flag, X.RDB$ACTIVE_FLAG);

		if (!X.RDB$AUTO_ENABLE.NULL)
			put_int32(att_pub_auto_enable, X.RDB$AUTO_ENABLE);

		put(tdgbl, att_end);
	}
	END_FOR
	ON_ERROR
		general_on_error();
	END_ERROR

	MISC_release_request_silent(req_handle);
}


void write_pub_tables()
{
/**************************************
 *
 *	w r i t e _ p u b _ t a b l e s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each publication table.
 *
 **************************************/
	QualifiedMetaString tableName;
	Firebird::IRequest* req_handle = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	FOR (REQUEST_HANDLE req_handle)
		X IN RDB$PUBLICATION_TABLES
	{
		put(tdgbl, rec_pub_table);

		PUT_TEXT(att_ptab_pub_name, X.RDB$PUBLICATION_NAME);

		if (!X.RDB$TABLE_SCHEMA_NAME.NULL)
		{
			PUT_TEXT(att_ptab_table_schema_name, X.RDB$TABLE_SCHEMA_NAME);
			tableName.schema = X.RDB$TABLE_SCHEMA_NAME;
		}

		PUT_TEXT(att_ptab_table_name, X.RDB$TABLE_NAME);
		tableName.object = X.RDB$TABLE_NAME;

		BURP_verbose(398, tableName.toQuotedString());
		// msg 398 writing publication for table %s

		put(tdgbl, att_end);
	}
	END_FOR
	ON_ERROR
		general_on_error();
	END_ERROR

	MISC_release_request_silent(req_handle);
}


void write_ref_constraints()
{
/**************************************
 *
 *	w r i t e _ r e f _ c o n s t r a i n t s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each referential constraint.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	FOR (REQUEST_HANDLE req_handle1)
		X IN RDB$REF_CONSTRAINTS
	{
		put(tdgbl, rec_ref_constraint);

		if (!X.RDB$SCHEMA_NAME.NULL)
			PUT_TEXT(att_ref_schema_name, X.RDB$SCHEMA_NAME);

		PUT_TEXT(att_ref_constraint_name, X.RDB$CONSTRAINT_NAME);

		if (!X.RDB$CONST_SCHEMA_NAME_UQ.NULL)
			PUT_TEXT(att_ref_unique_const_schema_name, X.RDB$CONST_SCHEMA_NAME_UQ);

		PUT_TEXT(att_ref_unique_const_name, X.RDB$CONST_NAME_UQ);

		PUT_TEXT(att_ref_match_option, X.RDB$MATCH_OPTION);
		PUT_TEXT(att_ref_update_rule, X.RDB$UPDATE_RULE);
		PUT_TEXT(att_ref_delete_rule, X.RDB$DELETE_RULE);
		put(tdgbl, att_end);
	}
	END_FOR
	ON_ERROR
		general_on_error();
	END_ERROR;

	MISC_release_request_silent(req_handle1);
}


void write_rel_constraints()
{
/**************************************
 *
 *	w r i t e _ r e l _ c o n s t r a i n t s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each relation constraint.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	FOR (REQUEST_HANDLE req_handle1)
		X IN RDB$RELATION_CONSTRAINTS CROSS
		REL IN RDB$RELATIONS
		WITH REL.RDB$SCHEMA_NAME EQUIV X.RDB$SCHEMA_NAME AND
			 REL.RDB$RELATION_NAME EQ X.RDB$RELATION_NAME AND
			 (REL.RDB$SYSTEM_FLAG MISSING OR REL.RDB$SYSTEM_FLAG NE 1)
	{
		QualifiedMetaString name;

		put(tdgbl, rec_rel_constraint);

		if (!X.RDB$SCHEMA_NAME.NULL)
		{
			PUT_TEXT(att_rel_constraint_schema_name, X.RDB$SCHEMA_NAME);
			name.schema = X.RDB$SCHEMA_NAME;
		}

		PUT_TEXT(att_rel_constraint_name, X.RDB$CONSTRAINT_NAME);
		name.object = X.RDB$CONSTRAINT_NAME;
		BURP_verbose(207, name.toQuotedString());
		// msg 207 writing constraint %s

		PUT_TEXT (att_rel_constraint_type, X.RDB$CONSTRAINT_TYPE);
		PUT_TEXT (att_rel_constraint_rel_name, X.RDB$RELATION_NAME);
		PUT_TEXT (att_rel_constraint_defer, X.RDB$DEFERRABLE);
		PUT_TEXT (att_rel_constraint_init, X.RDB$INITIALLY_DEFERRED);
		if (!X.RDB$INDEX_NAME.NULL)
			PUT_TEXT (att_rel_constraint_index, X.RDB$INDEX_NAME);
		put(tdgbl, att_end);
	}
	END_FOR
	ON_ERROR
		general_on_error();
	END_ERROR;

	MISC_release_request_silent(req_handle1);
}


void write_relations()
{
/**************************************
 *
 *	w r i t e _ r e l a t i o n s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each relation.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	// if we have all capabilities, use the first request to get the
	// most performance out of the latest engine; if we don't
	// have one of the capabilities we must use the second set of
	// requests--this requires more code but it is well worth it
	// for the performance benefits, especially remotely--deej

	if (tdgbl->runtimeODS >= DB_VERSION_DDL11_1)
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$RELATIONS WITH X.RDB$SYSTEM_FLAG NE 1 OR
			X.RDB$SYSTEM_FLAG MISSING
		{
			QualifiedMetaString name;

			SSHORT flags = 0;
			put(tdgbl, rec_relation);

			if (!X.RDB$SCHEMA_NAME.NULL)
			{
				PUT_TEXT(att_relation_schema_name, X.RDB$SCHEMA_NAME);
				name.schema = X.RDB$SCHEMA_NAME;
			}

			PUT_TEXT(att_relation_name, X.RDB$RELATION_NAME);
			name.object = X.RDB$RELATION_NAME;

			if (X.RDB$VIEW_BLR.NULL)
				BURP_verbose(153, name.toQuotedString()); // msg 153 writing table @1
			else
				BURP_verbose(345, name.toQuotedString()); // msg 345 writing view @1

			// RDB$VIEW_BLR must be the first blob field in the backup file.
			// RESTORE.EPP makes this assumption in get_relation().

			if (!X.RDB$VIEW_BLR.NULL && !BlobWrapper::blobIsNull(X.RDB$VIEW_BLR))
				flags |= REL_view;

			put_blr_blob (att_relation_view_blr, X.RDB$VIEW_BLR);

			if (X.RDB$SYSTEM_FLAG)
				put_int32 (att_relation_system_flag, X.RDB$SYSTEM_FLAG);
			if (!X.RDB$FLAGS.NULL)
				put_int32 (att_relation_flags, X.RDB$FLAGS);
			if (!X.RDB$SECURITY_CLASS.NULL)
				PUT_TEXT (att_relation_security_class, X.RDB$SECURITY_CLASS);

			put_source_blob (att_relation_description2, att_relation_description,
				X.RDB$DESCRIPTION);
			put_source_blob (att_relation_view_source2, att_relation_view_source, X.RDB$VIEW_SOURCE);

			put_source_blob(att_relation_ext_description2, att_relation_ext_description,
							X.RDB$EXTERNAL_DESCRIPTION);
			PUT_TEXT (att_relation_owner_name, X.RDB$OWNER_NAME);
			if (!X.RDB$EXTERNAL_FILE.NULL)
			{
				if (!tdgbl->gbl_sw_convert_ext_tables)
				{
					PUT_TEXT(att_relation_ext_file_name, X.RDB$EXTERNAL_FILE);
					flags |= REL_external;
				}
			}

			if (!X.RDB$RELATION_TYPE.NULL)
				put_int32 (att_relation_type, X.RDB$RELATION_TYPE);

			if (!X.RDB$SQL_SECURITY.NULL)
				put_boolean(att_relation_sql_security, X.RDB$SQL_SECURITY);

			put(tdgbl, att_end);
			burp_rel* relation = (burp_rel*) BURP_alloc_zero (sizeof(burp_rel));
			relation->rel_next = tdgbl->relations;
			tdgbl->relations = relation;
			relation->rel_id = X.RDB$RELATION_ID;

			if (!X.RDB$SCHEMA_NAME.NULL)
				relation->rel_name.schema = X.RDB$SCHEMA_NAME;

			relation->rel_name = name;
			relation->rel_flags |= flags;
			put_relation (relation);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR;
	}
	else
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$RELATIONS WITH X.RDB$SYSTEM_FLAG NE 1 OR
			X.RDB$SYSTEM_FLAG MISSING
		{
			QualifiedMetaString name;

			SSHORT flags = 0;
			put(tdgbl, rec_relation);
			PUT_TEXT(att_relation_name, X.RDB$RELATION_NAME);
			name.object = X.RDB$RELATION_NAME;
			BURP_verbose(153, name.toQuotedString());
			// msg 153 writing table %.*s

			// RDB$VIEW_BLR must be the first blob field in the backup file.
			// RESTORE.EPP makes this assumption in get_relation().

			if (!X.RDB$VIEW_BLR.NULL && !BlobWrapper::blobIsNull(X.RDB$VIEW_BLR))
				flags |= REL_view;

			put_blr_blob (att_relation_view_blr, X.RDB$VIEW_BLR);
			if (X.RDB$SYSTEM_FLAG)
				put_int32 (att_relation_system_flag, X.RDB$SYSTEM_FLAG);
			if (!X.RDB$FLAGS.NULL)
				put_int32 (att_relation_flags, X.RDB$FLAGS);
			if (!X.RDB$SECURITY_CLASS.NULL)
				PUT_TEXT(att_relation_security_class, X.RDB$SECURITY_CLASS);
			put_source_blob (att_relation_description2, att_relation_description, X.RDB$DESCRIPTION);
			put_source_blob (att_relation_view_source2, att_relation_view_source, X.RDB$VIEW_SOURCE);
			put_source_blob(att_relation_ext_description2, att_relation_ext_description,
							X.RDB$EXTERNAL_DESCRIPTION);
			PUT_TEXT(att_relation_owner_name, X.RDB$OWNER_NAME);
			if (!X.RDB$EXTERNAL_FILE.NULL)
			{
				if (!tdgbl->gbl_sw_convert_ext_tables)
				{
					PUT_TEXT(att_relation_ext_file_name, X.RDB$EXTERNAL_FILE);
					flags |= REL_external;
				}
			}
			put(tdgbl, att_end);
			burp_rel* relation = (burp_rel*) BURP_alloc_zero (sizeof(burp_rel));
			relation->rel_next = tdgbl->relations;
			tdgbl->relations = relation;
			relation->rel_id = X.RDB$RELATION_ID;
			relation->rel_name = name;
			relation->rel_flags |= flags;
			put_relation (relation);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}

	MISC_release_request_silent(req_handle1);
}


// Write a record in the burp file for each schema.
void write_schemas()
{
	IRequest* reqHandle1 = nullptr;
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	FOR (REQUEST_HANDLE reqHandle1)
		X IN RDB$SCHEMAS
		WITH X.RDB$SYSTEM_FLAG NE 1
	{
		put(tdgbl, rec_schema);

		PUT_TEXT(att_schema_name, X.RDB$SCHEMA_NAME);

		BURP_verbose(411, MetaString(X.RDB$SCHEMA_NAME).toQuotedString());	// msg 411 writing schema @1

		if (!X.RDB$CHARACTER_SET_SCHEMA_NAME.NULL)
			PUT_TEXT(att_schema_charset_schema_name, X.RDB$CHARACTER_SET_SCHEMA_NAME);

		if (!X.RDB$CHARACTER_SET_NAME.NULL)
			PUT_TEXT(att_schema_charset_name, X.RDB$CHARACTER_SET_NAME);

		if (!X.RDB$SQL_SECURITY.NULL)
			put_boolean(att_schema_sql_security, X.RDB$SQL_SECURITY);

		if (!X.RDB$SECURITY_CLASS.NULL)
			PUT_TEXT(att_schema_security_class, X.RDB$SECURITY_CLASS);

		if (!X.RDB$OWNER_NAME.NULL)
			PUT_TEXT(att_schema_owner_name, X.RDB$OWNER_NAME);

		if (!X.RDB$DESCRIPTION.NULL)
			put_source_blob(att_schema_description, att_schema_description, X.RDB$DESCRIPTION);

		put(tdgbl, att_end);
	}
	END_FOR
	ON_ERROR
		general_on_error();
	END_ERROR

	MISC_release_request_silent(reqHandle1);
}


void write_secclasses()
{
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	FOR (REQUEST_HANDLE req_handle1)
		X IN RDB$SECURITY_CLASSES WITH X.RDB$SECURITY_CLASS NOT STARTING "SQL$"
	{
		put(tdgbl, rec_security_class);
		PUT_TEXT(att_class_security_class, X.RDB$SECURITY_CLASS);
		BURP_verbose(155, MetaString(X.RDB$SECURITY_CLASS).toQuotedString());
		// msg 155 writing security class @1
		put_blr_blob (att_class_acl, X.RDB$ACL);
		put_source_blob (att_class_description2, att_class_description, X.RDB$DESCRIPTION);
		put(tdgbl, att_end);
	}
	END_FOR
	ON_ERROR
		general_on_error();
	END_ERROR

	MISC_release_request_silent(req_handle1);
}


void write_shadow_files()
{
/**************************************
 *
 *	w r i t e _ s h a d o w _ f i l e s
 *
 **************************************
 *
 * Functional description
 *	Write out files to use as shadows.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	FOR (REQUEST_HANDLE req_handle1)
		X IN RDB$FILES
		WITH X.RDB$SHADOW_NUMBER NOT MISSING
		AND X.RDB$SHADOW_NUMBER NE 0
	{
		put(tdgbl, rec_files);
		PUT_TEXT(att_file_filename, X.RDB$FILE_NAME);
		BURP_verbose(163, MetaString(X.RDB$FILE_NAME).toQuotedString());
		// msg 163 writing shadow file %s
		put_int32 (att_file_sequence, X.RDB$FILE_SEQUENCE);
		put_int32 (att_file_start, X.RDB$FILE_START);
		put_int32 (att_file_length, X.RDB$FILE_LENGTH);
		put_int32 (att_file_flags, X.RDB$FILE_FLAGS);
		put_int32 (att_shadow_number, X.RDB$SHADOW_NUMBER);
		put(tdgbl, att_end);
	}
	END_FOR
	ON_ERROR
		general_on_error();
	END_ERROR

	MISC_release_request_silent(req_handle1);
}


void write_sql_roles()
{
/**************************************
 *
 *	w r i t e _ s q l _ r o l e s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each SQL roles.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	if (tdgbl->runtimeODS >= DB_VERSION_DDL11)
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$ROLES
			WITH X.RDB$SYSTEM_FLAG EQ 0 OR X.RDB$SYSTEM_FLAG MISSING
		{
			put(tdgbl, rec_sql_roles);
			PUT_TEXT(att_role_name, X.RDB$ROLE_NAME);
			PUT_TEXT(att_role_owner_name, X.RDB$OWNER_NAME);
			if (!X.RDB$DESCRIPTION.NULL) {
				put_source_blob (att_role_description, att_role_description, X.RDB$DESCRIPTION);
			}

			constexpr UCHAR ll = sizeof(X.RDB$SYSTEM_PRIVILEGES);
			put(tdgbl, att_role_sys_priveleges);
			put(tdgbl, ll);
			put_block(tdgbl, (const UCHAR*) (X.RDB$SYSTEM_PRIVILEGES), ll);

			put(tdgbl, att_end);
			BURP_verbose(249, MetaString(X.RDB$ROLE_NAME).toQuotedString());
			// msg 249 writing SQL role: %s
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}
	else
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$ROLES
		{
			put(tdgbl, rec_sql_roles);
			PUT_TEXT(att_role_name, X.RDB$ROLE_NAME);
			PUT_TEXT(att_role_owner_name, X.RDB$OWNER_NAME);
			put(tdgbl, att_end);
			BURP_verbose(249, MetaString(X.RDB$ROLE_NAME).toQuotedString());
			// msg 249 writing SQL role: %s
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}

	MISC_release_request_silent(req_handle1);
}


void write_mapping()
{
/**************************************
 *
 *	w r i t e _ m a p p i n g
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each names mapping.
 *
 **************************************/
	Firebird::IRequest* req_handle = nullptr;
	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	if (tdgbl->runtimeODS >= DB_VERSION_DDL12)
	{
		FOR (REQUEST_HANDLE req_handle)
			M IN RDB$AUTH_MAPPING
			WITH M.RDB$SYSTEM_FLAG EQ 0
		{
			put(tdgbl, rec_mapping);
			PUT_TEXT(att_map_name, M.RDB$MAP_NAME);
			PUT_TEXT(att_map_using, M.RDB$MAP_USING);

			if (!M.RDB$MAP_PLUGIN.NULL)
				PUT_TEXT(att_map_plugin, M.RDB$MAP_PLUGIN);

			if (!M.RDB$MAP_DB.NULL)
				PUT_TEXT(att_map_db, M.RDB$MAP_DB);

			PUT_TEXT(att_map_from_type, M.RDB$MAP_FROM_TYPE);

			if (!M.RDB$MAP_FROM.NULL)
				PUT_TEXT(att_map_from, M.RDB$MAP_FROM);

			put_int32(att_map_to_type, M.RDB$MAP_TO_TYPE);

			if (!M.RDB$MAP_TO.NULL)
				PUT_TEXT(att_map_to, M.RDB$MAP_TO);

			if (!M.RDB$DESCRIPTION.NULL)
				put_source_blob(att_map_description, att_map_description, M.RDB$DESCRIPTION);

			put(tdgbl, att_end);

			BURP_verbose(297, MetaString(M.RDB$MAP_NAME).toQuotedString());
			// msg 297 writing mapping for %s
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}
	else if (tdgbl->runtimeODS >= DB_VERSION_DDL11_2)
	{
		FOR (REQUEST_HANDLE req_handle)
			X IN RDB$ROLES
			WITH X.RDB$ROLE_NAME EQ ADMIN_ROLE
		{
			if (X.RDB$SYSTEM_FLAG == 6)		// constant 6 turns on auto admin mapping in FB 2.5
			{
				put(tdgbl, rec_mapping);
				put_text(att_auto_map_role, ADMIN_ROLE, static_cast<SSHORT>(strlen(ADMIN_ROLE) + 1));
				put(tdgbl, att_end);
				BURP_verbose(297, MetaString(ADMIN_ROLE).toQuotedString());
				// msg 297 writing mapping for @1
			}
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}

	MISC_release_request_silent(req_handle);
}


void write_db_creators()
{
/**************************************
 *
 *	w r i t e _ d b _ c r e a t o r s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each grant to create database.
 *
 **************************************/
	Firebird::IRequest* req_handle = nullptr;
	bool first = true;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	FOR (REQUEST_HANDLE req_handle)
		C IN RDB$DB_CREATORS

		if (first)
		{
			BURP_verbose(391);
			// msg 391 writing database create grants
			first = false;
		}

		bool fl = true;

		if (!C.RDB$USER_TYPE.NULL)
		{
			put(tdgbl, rec_db_creator);
			fl = false;
			put_int32(att_dbc_type, C.RDB$USER_TYPE);
		}

		if (!C.RDB$USER.NULL)
		{
			if (fl)
				put(tdgbl, rec_db_creator);
			fl = false;
			PUT_TEXT(att_dbc_user, C.RDB$USER);

			BURP_verbose(392, MetaString(C.RDB$USER).toQuotedString());
			// msg 392 writing db creator %s
		}

		if (!fl)
			put(tdgbl, att_end);

	END_FOR;
	ON_ERROR
		general_on_error();
	END_ERROR;

	MISC_release_request_silent(req_handle);
}


void write_triggers()
{
/**************************************
 *
 *	w r i t e _ t r i g g e r s
 *
 **************************************
 *
 * Functional description
 * 	write the triggers in rdb$triggers
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	// if we have all capabilities, use the first request to get the
	// most performance out of the latest engine; if we don't
	// have one of the capabilities we must use the second set of
	// requests--this requires more code but it is well worth it
	// for the performance benefits, especially remotely--deej

	if (tdgbl->runtimeODS >= DB_VERSION_DDL11_1)
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$TRIGGERS WITH
			X.RDB$SYSTEM_FLAG NE 1 OR
			X.RDB$SYSTEM_FLAG MISSING
		{
			QualifiedMetaString name;

			put(tdgbl, rec_trigger);

			if (!X.RDB$SCHEMA_NAME.NULL)
			{
				PUT_TEXT(att_trig_schema_name, X.RDB$SCHEMA_NAME);
				name.schema = X.RDB$SCHEMA_NAME;
			}

			PUT_TEXT(att_trig_name, X.RDB$TRIGGER_NAME);
			name.object = X.RDB$TRIGGER_NAME;
			BURP_verbose(156, name.toQuotedString());
			// msg 156   writing trigger %s

			if (!X.RDB$RELATION_NAME.NULL)
				PUT_TEXT (att_trig_relation_name, X.RDB$RELATION_NAME);

			put_int32 (att_trig_sequence, X.RDB$TRIGGER_SEQUENCE);

			if (X.RDB$TRIGGER_TYPE >= SLONG_MIN && X.RDB$TRIGGER_TYPE <= SLONG_MAX)
				put_int32 (att_trig_type, (SLONG) X.RDB$TRIGGER_TYPE);
			else
				put_int64 (att_trig_type2, X.RDB$TRIGGER_TYPE);

			put_blr_blob (att_trig_blr, X.RDB$TRIGGER_BLR);
			put_source_blob (att_trig_source2, att_trig_source, X.RDB$TRIGGER_SOURCE);
			put_source_blob (att_trig_description2, att_trig_description, X.RDB$DESCRIPTION);
			put_int32 (att_trig_system_flag, X.RDB$SYSTEM_FLAG);
			put_int32 (att_trig_inactive, X.RDB$TRIGGER_INACTIVE);

			if (!X.RDB$FLAGS.NULL)
				put_int32 (att_trig_flags, X.RDB$FLAGS);

			if (!X.RDB$VALID_BLR.NULL)
				put_int32 (att_trig_valid_blr, X.RDB$VALID_BLR);

			if (!X.RDB$DEBUG_INFO.NULL)
				put_blr_blob (att_trig_debug_info, X.RDB$DEBUG_INFO);

			if (!X.RDB$ENGINE_NAME.NULL)
				PUT_TEXT(att_trig_engine_name, X.RDB$ENGINE_NAME);

			if (!X.RDB$ENTRYPOINT.NULL)
				PUT_TEXT(att_trig_entrypoint, X.RDB$ENTRYPOINT);

			if (!X.RDB$SQL_SECURITY.NULL)
				put_boolean(att_trig_sql_security, X.RDB$SQL_SECURITY);

			put(tdgbl, att_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR;
	}
	else
	{
		FOR (REQUEST_HANDLE req_handle1)
			X IN RDB$TRIGGERS WITH
			X.RDB$SYSTEM_FLAG NE 1 OR
			X.RDB$SYSTEM_FLAG MISSING
		{
			QualifiedMetaString name;

			put(tdgbl, rec_trigger);

			PUT_TEXT(att_trig_name, X.RDB$TRIGGER_NAME);
			name.object = X.RDB$TRIGGER_NAME;
			BURP_verbose(156, name.toQuotedString());
			// msg 156   writing trigger %s

			if (!X.RDB$RELATION_NAME.NULL)
				PUT_TEXT (att_trig_relation_name, X.RDB$RELATION_NAME);

			put_int32 (att_trig_sequence, X.RDB$TRIGGER_SEQUENCE);
			put_int32 (att_trig_type, X.RDB$TRIGGER_TYPE);
			put_blr_blob (att_trig_blr, X.RDB$TRIGGER_BLR);
			put_source_blob (att_trig_source2, att_trig_source, X.RDB$TRIGGER_SOURCE);
			put_source_blob (att_trig_description2, att_trig_description, X.RDB$DESCRIPTION);
			put_int32 (att_trig_system_flag, X.RDB$SYSTEM_FLAG);
			put_int32 (att_trig_inactive, X.RDB$TRIGGER_INACTIVE);

			if (!X.RDB$FLAGS.NULL)
				put_int32 (att_trig_flags, X.RDB$FLAGS);

			put(tdgbl, att_end);
		}
		END_FOR
		ON_ERROR
			general_on_error();
		END_ERROR
	}

	MISC_release_request_silent(req_handle1);
}


void write_trigger_messages()
{
/**************************************
 *
 *	w r i t e _ t r i g g e r _ m e s s a g e s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each trigger message.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	FOR (REQUEST_HANDLE req_handle1)
		T IN RDB$TRIGGERS
		CROSS X IN RDB$TRIGGER_MESSAGES
		WITH X.RDB$SCHEMA_NAME EQUIV T.RDB$SCHEMA_NAME AND
			 X.RDB$TRIGGER_NAME EQ T.RDB$TRIGGER_NAME AND
			 T.RDB$SYSTEM_FLAG NE 1 OR T.RDB$SYSTEM_FLAG MISSING
	{
		QualifiedMetaString name;

		put(tdgbl, rec_trigger_message);

		if (!X.RDB$SCHEMA_NAME.NULL)
		{
			PUT_TEXT(att_trigmsg_schema_name, X.RDB$SCHEMA_NAME);
			name.schema = X.RDB$SCHEMA_NAME;
		}

		PUT_TEXT(att_trigmsg_name, X.RDB$TRIGGER_NAME);
		name.object = X.RDB$TRIGGER_NAME;

		BURP_verbose(157, name.toQuotedString());
		// msg 157 writing trigger message for %s

		put_int32 (att_trigmsg_number, X.RDB$MESSAGE_NUMBER);
		PUT_MESSAGE (att_trigmsg_text, att_end, X.RDB$MESSAGE);
		put(tdgbl, att_end);
	}
	END_FOR
	ON_ERROR
		general_on_error();
	END_ERROR;

	MISC_release_request_silent(req_handle1);
}


void write_types()
{
/**************************************
 *
 *	w r i t e _ t y p e s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each type.
 *
 **************************************/
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	FOR (REQUEST_HANDLE req_handle1)
		X IN RDB$TYPES WITH X.RDB$SYSTEM_FLAG NE 1 OR
		X.RDB$SYSTEM_FLAG MISSING
	{
		put(tdgbl, rec_system_type);
		PUT_TEXT (att_type_name, X.RDB$TYPE_NAME);
		PUT_TEXT (att_type_field_name, X.RDB$FIELD_NAME);
		BURP_verbose (160, SafeArg() << X.RDB$TYPE_NAME << X.RDB$FIELD_NAME);
		// msg 160 writing type %s for field %s
		put_int32 (att_type_type, X.RDB$TYPE);
		put_source_blob (att_type_description2, att_type_description, X.RDB$DESCRIPTION);
		if (X.RDB$SYSTEM_FLAG)
			put_int32 (att_type_system_flag, X.RDB$SYSTEM_FLAG);
		put(tdgbl, att_end);
	}
	END_FOR
	ON_ERROR
		general_on_error();
	END_ERROR

	MISC_release_request_silent(req_handle1);
}


void write_user_privileges()
{
/**************************************
 *
 *	w r i t e _ u s e r _ p r i v i l e g e s
 *
 **************************************
 *
 * Functional description
 * 	write a record in the burp file for
 *	each user privilege.
 *
 **************************************/
	QualifiedMetaString user;
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	FOR (REQUEST_HANDLE req_handle1)
		X IN RDB$USER_PRIVILEGES
		WITH X.RDB$GRANTOR NOT MISSING
	{
		put(tdgbl, rec_user_privilege);

		if (!X.RDB$USER_SCHEMA_NAME.NULL)
		{
			PUT_TEXT(att_priv_user_schema_name, X.RDB$USER_SCHEMA_NAME);
			user.schema = X.RDB$USER_SCHEMA_NAME;
		}

		PUT_TEXT(att_priv_user, X.RDB$USER);
		user.object = X.RDB$USER;
		BURP_verbose(152, user.toQuotedString());
		// msg 152 writing privilege for user %s

		PUT_TEXT (att_priv_grantor, X.RDB$GRANTOR);
		PUT_TEXT (att_priv_privilege, X.RDB$PRIVILEGE);
		if (!X.RDB$GRANT_OPTION.NULL)
			put_int32 (att_priv_grant_option, X.RDB$GRANT_OPTION);

		if (!X.RDB$RELATION_SCHEMA_NAME.NULL)
			PUT_TEXT(att_priv_object_schema_name, X.RDB$RELATION_SCHEMA_NAME);

		PUT_TEXT(att_priv_object_name, X.RDB$RELATION_NAME);

		if (!X.RDB$FIELD_NAME.NULL)
		   PUT_TEXT (att_priv_field_name, X.RDB$FIELD_NAME);
		put_int32 (att_priv_user_type, X.RDB$USER_TYPE);
		put_int32 (att_priv_obj_type, X.RDB$OBJECT_TYPE);
		put(tdgbl, att_end);
	}
	END_FOR
	ON_ERROR
		general_on_error();
	END_ERROR;

	MISC_release_request_silent(req_handle1);
}

void write_constants()
{
	Firebird::IRequest* req_handle1 = nullptr;

	BurpGlobals* tdgbl = BurpGlobals::getSpecific();

	FOR (REQUEST_HANDLE req_handle1)
		CONST IN RDB$CONSTANTS
		WITH CONST.RDB$SCHEMA_NAME NE SYSTEM_SCHEMA
	{
		QualifiedMetaString name(CONST.RDB$CONSTANT_NAME);

		put(tdgbl, rec_constants);
		PUT_TEXT(att_constant_name, CONST.RDB$CONSTANT_NAME);

		PUT_TEXT(att_constant_package, CONST.RDB$PACKAGE_NAME);
		name.package = CONST.RDB$PACKAGE_NAME;

		PUT_TEXT(att_constant_field_source, CONST.RDB$FIELD_SOURCE);

		if (!CONST.RDB$PRIVATE_FLAG.NULL)
			put_int32(att_constant_private_flag, CONST.RDB$PRIVATE_FLAG);

		if (!CONST.RDB$CONSTANT_BLR.NULL)
			put_blr_blob(att_constant_blr, CONST.RDB$CONSTANT_BLR);

		if (!CONST.RDB$CONSTANT_SOURCE.NULL)
			put_source_blob(att_constant_source, att_constant_source, CONST.RDB$CONSTANT_SOURCE);

		if (!CONST.RDB$SCHEMA_NAME.NULL)
		{
			PUT_TEXT(att_constant_schema_name, CONST.RDB$SCHEMA_NAME);
			name.schema = CONST.RDB$SCHEMA_NAME;
		}

		if (!CONST.RDB$DESCRIPTION.NULL)
		{
			put_source_blob (att_constant_description, att_constant_description, CONST.RDB$DESCRIPTION);
		}

		// writing constant %s
		BURP_verbose(USHORT(isc_gbak_writing_constant), SafeArg() << name.toQuotedString().data());
		put(tdgbl, att_end);
	}
	END_FOR;
	ON_ERROR
		general_on_error();
	END_ERROR;

	MISC_release_request_silent(req_handle1);
}

} // namespace

namespace Burp {

/// class ReadRelationMeta

void ReadRelationMeta::setRelation(const burp_rel* relation, bool partition)
{
	m_relation = relation;

	// Build request BLR. There could be two kind of requests :
	// a) partition == true
	//		SELECT * FROM relation
	//		 WHERE dbkey >= MAKE_DBKEY(rel_id, 0, 0, :loPP)
	//		   AND dbkey  < MAKE_DBKEY(rel_id, 0, 0, :hiPP)
	// b) partition = false
	//		SELECT * FROM relation
	// Note, computed fields are not included into results

	// CVC: A signed short isn't enough if the engine allows near 32K fields,
	// each being char(1) ASCII in the worst case. Looking at BLR generation
	// below, it's clear an extreme case won't compile => blr_length >= 32K.
	// However, SSHORT is the limit for request_length in isc_compile_request.
	m_fldCount = 1;
	burp_fld* field;

	for (field = relation->rel_fields; field; field = field->fld_next)
	{
		if (!(field->fld_flags & FLD_computed))
		{
			m_fldCount += 2;
		}
	}
	fb_assert(m_fldCount > 0 && m_fldCount * 9 > 0 && m_fldCount * 9 + 200 > 0);

	// Time to generate blr to fetch data.  Make sure we allocate a BLR buffer
	// large enough to handle the per field overhead
	UCHAR* const blr_buffer = m_blr.getBuffer(200 + m_fldCount * 9);
	UCHAR* blr = blr_buffer;
	add_byte(blr, blr_version4);
	add_byte(blr, blr_begin);

	// in message
	m_inMgsNum = m_outMgsNum = 0;
	if (partition)
	{
		add_byte(blr, blr_message);
		add_byte(blr, m_inMgsNum);		// Message number
		add_word(blr, 2);				//
		add_byte(blr, blr_long);		// loPP
		add_byte(blr, 0);
		add_byte(blr, blr_long);		// hiPP
		add_byte(blr, 0);

		m_outMgsNum = m_inMgsNum + 1;
	}

	// out message
	add_byte(blr, blr_message);
	add_byte(blr, m_outMgsNum);		// Message number
	add_word(blr, m_fldCount);		// Number of fields, counting eof

	RCRD_OFFSET offset = 0;
	SSHORT count = 0;   // This is param count.

	for (field = relation->rel_fields; field; field = field->fld_next)
	{
		if (field->fld_flags & FLD_computed)
			continue;

		SSHORT alignment = 4;
		FLD_LENGTH length = field->fld_length;
		auto blrType = field->fld_type;

		if (field->fld_flags & FLD_array)
			blrType = blr_blob;

		if (blrType <= DTYPE_BLR_MAX)
		{
			const auto dtype = gds_cvt_blr_dtype[blrType];
			alignment = type_alignments[dtype];
		}

		switch (blrType)
		{
		case blr_text:
		case blr_varying:
			add_byte(blr, field->fld_type);
			add_word(blr, field->fld_length);
			if (blrType == blr_varying)
				length += sizeof(USHORT);
			break;

		case blr_short:
		case blr_long:
		case blr_quad:
		case blr_int64:
		case blr_int128:
			add_byte(blr, field->fld_type);
			add_byte(blr, field->fld_scale);
			break;

		case blr_float:
		case blr_double:
		case blr_timestamp:
		case blr_timestamp_tz:
		case blr_sql_time:
		case blr_sql_time_tz:
		case blr_sql_date:
		case blr_bool:
		case blr_dec64:
		case blr_dec128:
			add_byte(blr, field->fld_type);
			break;

		case blr_blob:
			alignment = type_alignments[dtype_blob];
			length = type_lengths[dtype_blob];
			add_byte(blr, blr_quad);
			add_byte(blr, 0);
			break;

		default:
			BURP_error(26, true, SafeArg() << field->fld_type);
			// msg 26 datatype %ld not understood
			break;
		}

		if (alignment)
			offset = FB_ALIGN(offset, alignment);

		field->fld_offset = offset;
		field->fld_parameter = count++;
		offset += length;
	}

	// Next, build fields for null flags

	for (field = relation->rel_fields; field; field = field->fld_next)
	{
		if (field->fld_flags & FLD_computed)
			continue;
		add_byte(blr, blr_short);
		add_byte(blr, 0);
		offset = FB_ALIGN(offset, sizeof(SSHORT));
		field->fld_missing_parameter = count++;
		offset += sizeof(SSHORT);
	}

	// Finally, make up an EOF field

	add_byte(blr, blr_short);			// eof field
	add_byte(blr, 0);					// scale for eof field
	const SSHORT eof_parameter = count++;
	m_outRecLen = offset;
	m_outEofOffset = FB_ALIGN(offset, sizeof(SSHORT));
	// To be used later for the buffer size to receive data
	m_outMsgLen = m_outEofOffset + sizeof(SSHORT);

	if (partition)
	{
		add_byte(blr, blr_receive);
		add_byte(blr, m_inMgsNum);
	}

	// Build FOR loop, body, and eof handler

	add_byte(blr, blr_for);
	add_byte(blr, blr_rse);
	add_byte(blr, 1);					// count of relations
	add_byte(blr, blr_rid);
	add_word(blr, relation->rel_id);
	add_byte(blr, 0);					// context variable

	if (partition)
	{
		// add boolean condition
		add_byte(blr, blr_boolean);
		add_byte(blr, blr_and);
		add_byte(blr, blr_geq);
		add_byte(blr, blr_dbkey);
		add_byte(blr, 0);
		add_byte(blr, blr_sys_function);
		add_string(blr, "MAKE_DBKEY");
		add_byte(blr, 4);
		add_byte(blr, blr_literal);		// relID
		add_byte(blr, blr_long);
		add_byte(blr, 0);
		add_long(blr, relation->rel_id);
		add_byte(blr, blr_literal);		// recNo
		add_byte(blr, blr_long);
		add_byte(blr, 0);
		add_long(blr, 0);
		add_byte(blr, blr_literal);		// DP
		add_byte(blr, blr_long);
		add_byte(blr, 0);
		add_long(blr, 0);
		add_byte(blr, blr_parameter);	// PP
		add_byte(blr, m_inMgsNum);
		add_word(blr, 0);
		add_byte(blr, blr_lss);
		add_byte(blr, blr_dbkey);
		add_byte(blr, 0);
		add_byte(blr, blr_sys_function);
		add_string(blr, "MAKE_DBKEY");
		add_byte(blr, 4);
		add_byte(blr, blr_literal);		// relID
		add_byte(blr, blr_long);
		add_byte(blr, 0);
		add_long(blr, relation->rel_id);
		add_byte(blr, blr_literal);		// recNo
		add_byte(blr, blr_long);
		add_byte(blr, 0);
		add_long(blr, 0);
		add_byte(blr, blr_literal);		// DP
		add_byte(blr, blr_long);
		add_byte(blr, 0);
		add_long(blr, 0);
		add_byte(blr, blr_parameter);	// PP
		add_byte(blr, m_inMgsNum);
		add_word(blr, 1);
	}

	// rse end
	add_byte(blr, blr_end);

	add_byte(blr, blr_send);
	add_byte(blr, m_outMgsNum);
	add_byte(blr, blr_begin);
	add_byte(blr, blr_assignment);
	add_byte(blr, blr_literal);
	add_byte(blr, blr_short);
	add_byte(blr, 0);
	add_word(blr, 1);
	add_byte(blr, blr_parameter);
	add_byte(blr, m_outMgsNum);
	add_word(blr, eof_parameter);

	for (field = relation->rel_fields; field; field = field->fld_next)
	{
		if (field->fld_flags & FLD_computed)
			continue;
		add_byte(blr, blr_assignment);
		add_byte(blr, blr_fid);
		add_byte(blr, 0);						// context
		add_word(blr, field->fld_id);
		add_byte(blr, blr_parameter2);
		add_byte(blr, m_outMgsNum);				// message number
		add_word(blr, field->fld_parameter);
		add_word(blr, field->fld_missing_parameter);
	}

	add_byte(blr, blr_end);

	add_byte(blr, blr_send);
	add_byte(blr, m_outMgsNum);
	add_byte(blr, blr_assignment);
	add_byte(blr, blr_literal);
	add_byte(blr, blr_short);
	add_byte(blr, 0);
	add_word(blr, 0);
	add_byte(blr, blr_parameter);
	add_byte(blr, m_outMgsNum);
	add_word(blr, eof_parameter);

	add_byte(blr, blr_end);
	add_byte(blr, blr_eoc);

	const FB_SIZE_T blr_length = blr - blr_buffer;
	m_blr.shrink(blr_length);

#ifdef DEBUG
	if (debug_on)
		fb_print_blr(blr_buffer, blr_length, NULL, NULL, 0);
#endif
}

void ReadRelationMeta::clear()
{
	m_relation = NULL;
	m_fldCount = 0;
	m_blr.clear();
	m_inMgsNum = m_outMgsNum = 0;
	m_outMsgLen = m_outRecLen = m_outEofOffset = 0;
}


/// class ReadRelationReq

void ReadRelationReq::reset(const ReadRelationMeta* meta)
{
	if (m_meta == meta && meta != NULL && m_relation == meta->m_relation)
		return;

	if (m_meta)
		clear();

	m_meta = meta;
	if (m_meta)
	{
		m_relation = m_meta->m_relation;

		BurpGlobals* tdgbl = BurpGlobals::getSpecific();
		FbLocalStatus status;
		compile(&status, DB);
		if (status->getState() & IStatus::STATE_ERRORS)
		{
			BURP_error_redirect(&status, 27);
			// msg 27 isc_compile_request failed
			fb_print_blr(m_meta->m_blr.begin(), m_meta->m_blr.getCount(), NULL, NULL, 0);
		}

		UCHAR* data = m_outMsg.getBuffer(m_meta->m_outMsgLen);
		m_eof = reinterpret_cast<SSHORT*> (data + m_meta->m_outEofOffset);
	}
	else
	{
		m_relation = NULL;
		m_request = 0;
		m_eof = NULL;
	}

	memset(&m_inMgs, 0, sizeof(m_inMgs));
}

void ReadRelationReq::clear()
{
	m_relation = NULL;
	m_meta = NULL;
	m_eof = NULL;
	m_outMsg.clear();

	if (m_request)
	{
		FbLocalStatus status;
		release(&status);
	}
}

void ReadRelationReq::compile(CheckStatusWrapper* status, IAttachment* att)
{
	m_request = att->compileRequest(status, m_meta->m_blr.getCount(), m_meta->m_blr.begin());
}

void ReadRelationReq::release(CheckStatusWrapper* status)
{
	if (m_request)
	{
		m_request->free(status);

		if (!(status->getState() & IStatus::STATE_ERRORS))
		{
			m_request = nullptr;
			clear();
		}
	}
}

void ReadRelationReq::setParams(ULONG loPP, ULONG hiPP)
{
	m_inMgs.loPP = loPP;
	m_inMgs.hiPP = hiPP;
}

void ReadRelationReq::start(CheckStatusWrapper* status, ITransaction* tran)
{
	if (m_meta->haveInputs())
		m_request->startAndSend(status, tran, 0, m_meta->m_inMgsNum, sizeof(m_inMgs), &m_inMgs);
	else
		m_request->start(status, tran, 0);
}

void ReadRelationReq::receive(CheckStatusWrapper* status)
{
	m_request->receive(status, 0, m_meta->m_outMgsNum, m_meta->m_outMsgLen, m_outMsg.begin());
}


/// class BackupRelationTask

bool BackupRelationTask::tableReader(Item& item)
{
	item.m_request.reset(&m_metadata);
	item.m_request.setParams(item.m_ppSequence, item.m_ppSequence + 1);

	put_data(item.m_relation, &item.m_request);

	item.getBackupTask()->releaseBuffer(item);
	return true;
}

} // namespace Burp