embindex.c

Synopsis

Prototype

void embBtreeIndexEntry (
      EmbPBtreeEntry entry,
      ajuint dbno
);

Type Name Read/Write Description

EmbPBtreeEntry entry Modify Entry with id

ajuint dbno Input Database number for an identifier index field

void RETURN

Type	Name	Read/Write	Description
EmbPBtreeEntry	entry	Modify	Entry with id
ajuint	dbno	Input	Database number for an identifier index field
void		RETURN

Input

dbno:

(Input)

Database number for an identifier index field

Input & Output

entry:

(Modify)

Entry with id

Returns

void:

No return value

Description

Add a term to an index entry cache

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Synopsis

Prototype

void embBtreeIndexField (
      EmbPBtreeField field,
      const EmbPBtreeEntry entry,
      ajuint dbno
);

Type Name Read/Write Description

EmbPBtreeField field Modify Field with list of data

const EmbPBtreeEntry entry Input Entry with id

ajuint dbno Input Database number for an identifier index field

void RETURN

Type	Name	Read/Write	Description
EmbPBtreeField	field	Modify	Field with list of data
const EmbPBtreeEntry	entry	Input	Entry with id
ajuint	dbno	Input	Database number for an identifier index field
void		RETURN

Input

entry:	(Input)	Entry with id
dbno:	(Input)	Database number for an identifier index field

Input & Output

field:

(Modify)

Field with list of data

Returns

void:

No return value

Description

Add a term to an index field cache

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeParseEntry

Parse an entry ID from an input record

Synopsis

Prototype

void embBtreeParseEntry (
      const AjPStr readline,
      AjPRegexp regexp,
      EmbPBtreeEntry entry
);

Type Name Read/Write Description

const AjPStr readline Input INput record

AjPRegexp regexp Modify Regular expression to extract tokens

EmbPBtreeEntry entry Modify Entry

void RETURN

Type	Name	Read/Write	Description
const AjPStr	readline	Input	INput record
AjPRegexp	regexp	Modify	Regular expression to extract tokens
EmbPBtreeEntry	entry	Modify	Entry
void		RETURN

Input

readline:

(Input)

INput record

Input & Output

regexp:	(Modify)	Regular expression to extract tokens
entry:	(Modify)	Entry

Returns

void:

No return value

Description

Parse an entry ID from an input record

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeParseField

Parse field tokens from an input record, iterating over a regular expression.

Synopsis

Prototype

void embBtreeParseField (
      const AjPStr readline,
      AjPRegexp regexp,
      EmbPBtreeField field
);

Type Name Read/Write Description

const AjPStr readline Input Input record

AjPRegexp regexp Modify Regular expression to extract tokens

EmbPBtreeField field Modify Field

void RETURN

Type	Name	Read/Write	Description
const AjPStr	readline	Input	Input record
AjPRegexp	regexp	Modify	Regular expression to extract tokens
EmbPBtreeField	field	Modify	Field
void		RETURN

Input

readline:

(Input)

Input record

Input & Output

regexp:	(Modify)	Regular expression to extract tokens
field:	(Modify)	Field

Returns

void:

No return value

Description

Parse field tokens from an input record, iterating over a regular expression.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeParseFieldSecond

Parse field tokens from an input record using the first and second matches to a regular expression.

Synopsis

Prototype

void embBtreeParseFieldSecond (
      const AjPStr readline,
      AjPRegexp regexp,
      EmbPBtreeField field
);

Type Name Read/Write Description

const AjPStr readline Input Input record

AjPRegexp regexp Modify Regular expression to extract tokens

EmbPBtreeField field Modify Field

void RETURN

Type	Name	Read/Write	Description
const AjPStr	readline	Input	Input record
AjPRegexp	regexp	Modify	Regular expression to extract tokens
EmbPBtreeField	field	Modify	Field
void		RETURN

Input

readline:

(Input)

Input record

Input & Output

regexp:	(Modify)	Regular expression to extract tokens
field:	(Modify)	Field

Returns

void:

No return value

Description

Parse field tokens from an input record using the first and second matches to a regular expression.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeParseFieldThird

Parse field tokens from an input record using the first and third matches to a regular expression.

Synopsis

Prototype

void embBtreeParseFieldThird (
      const AjPStr readline,
      AjPRegexp regexp,
      EmbPBtreeField field
);

Type Name Read/Write Description

const AjPStr readline Input Input record

AjPRegexp regexp Modify Regular expression to extract tokens

EmbPBtreeField field Modify Field

void RETURN

Type	Name	Read/Write	Description
const AjPStr	readline	Input	Input record
AjPRegexp	regexp	Modify	Regular expression to extract tokens
EmbPBtreeField	field	Modify	Field
void		RETURN

Input

readline:

(Input)

Input record

Input & Output

regexp:	(Modify)	Regular expression to extract tokens
field:	(Modify)	Field

Returns

void:

No return value

Description

Parse field tokens from an input record using the first and third matches to a regular expression.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeParseFieldTrim

Parse field tokens from an input record and trim any trailing whitespace, iterating over a regular expression.

Synopsis

Prototype

void embBtreeParseFieldTrim (
      const AjPStr readline,
      AjPRegexp regexp,
      EmbPBtreeField field
);

Type Name Read/Write Description

const AjPStr readline Input Input record

AjPRegexp regexp Modify Regular expression to extract tokens

EmbPBtreeField field Modify Field

void RETURN

Type	Name	Read/Write	Description
const AjPStr	readline	Input	Input record
AjPRegexp	regexp	Modify	Regular expression to extract tokens
EmbPBtreeField	field	Modify	Field
void		RETURN

Input

readline:

(Input)

Input record

Input & Output

regexp:	(Modify)	Regular expression to extract tokens
field:	(Modify)	Field

Returns

void:

No return value

Description

Parse field tokens from an input record and trim any trailing whitespace, iterating over a regular expression.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeReportEntry

Report on indexing of entries

Synopsis

Prototype

void embBtreeReportEntry (
      AjPFile outf,
      const EmbPBtreeEntry entry
);

Type Name Read/Write Description

AjPFile outf Modify Output file

const EmbPBtreeEntry entry Input Entry

void RETURN

Type	Name	Read/Write	Description
AjPFile	outf	Modify	Output file
const EmbPBtreeEntry	entry	Input	Entry
void		RETURN

Input

entry:

(Input)

Entry

Input & Output

outf:

(Modify)

Output file

Returns

void:

No return value

Description

Report on indexing of entries

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeReportField

Report on indexing of field

Synopsis

Prototype

void embBtreeReportField (
      AjPFile outf,
      const EmbPBtreeField field
);

Type Name Read/Write Description

AjPFile outf Modify Output file

const EmbPBtreeField field Input Field

void RETURN

Type	Name	Read/Write	Description
AjPFile	outf	Modify	Output file
const EmbPBtreeField	field	Input	Field
void		RETURN

Input

field:

(Input)

Field

Input & Output

outf:

(Modify)

Output file

Returns

void:

No return value

Description

Report on indexing of field

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeEmblKW

Extract keywords from an EMBL KW line

Synopsis

Prototype

void embBtreeEmblKW (
      const AjPStr kwline,
      AjPList kwlist,
      ajuint maxlen
);

Type Name Read/Write Description

const AjPStr kwline Input keyword line

AjPList kwlist Output list of keywords

ajuint maxlen Input max keyword length

void RETURN

Type	Name	Read/Write	Description
const AjPStr	kwline	Input	keyword line
AjPList	kwlist	Output	list of keywords
ajuint	maxlen	Input	max keyword length
void		RETURN

Input

kwline:	(Input)	keyword line
maxlen:	(Input)	max keyword length

Output

kwlist:

(Output)

list of keywords

Returns

void:

No return value

Description

Extract keywords from an EMBL KW line

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeEmblTX

Extract keywords from an EMBL OC or OS line

Synopsis

Prototype

void embBtreeEmblTX (
      const AjPStr txline,
      AjPList txlist,
      ajuint maxlen
);

Type Name Read/Write Description

const AjPStr txline Input taxonomy line

AjPList txlist Output list of taxons

ajuint maxlen Input max taxon length

void RETURN

Type	Name	Read/Write	Description
const AjPStr	txline	Input	taxonomy line
AjPList	txlist	Output	list of taxons
ajuint	maxlen	Input	max taxon length
void		RETURN

Input

txline:	(Input)	taxonomy line
maxlen:	(Input)	max taxon length

Output

txlist:

(Output)

list of taxons

Returns

void:

No return value

Description

Extract keywords from an EMBL OC or OS line

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeEmblAC

Extract accession numbers from an EMBL AC line

Synopsis

Prototype

void embBtreeEmblAC (
      const AjPStr acline,
      AjPList aclist
);

Type Name Read/Write Description

const AjPStr acline Input AC line

AjPList aclist Output list of accession numbers

void RETURN

Type	Name	Read/Write	Description
const AjPStr	acline	Input	AC line
AjPList	aclist	Output	list of accession numbers
void		RETURN

Input

acline:

(Input)

AC line

Output

aclist:

(Output)

list of accession numbers

Returns

void:

No return value

Description

Extract accession numbers from an EMBL AC line

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeEmblSV

Extract sequence version from an EMBL new format ID line

Synopsis

Prototype

void embBtreeEmblSV (
      const AjPStr idline,
      AjPList svlist
);

Type Name Read/Write Description

const AjPStr idline Input AC line

AjPList svlist Output list of accession numbers

void RETURN

Type	Name	Read/Write	Description
const AjPStr	idline	Input	AC line
AjPList	svlist	Output	list of accession numbers
void		RETURN

Input

idline:

(Input)

AC line

Output

svlist:

(Output)

list of accession numbers

Returns

void:

No return value

Description

Extract sequence version from an EMBL new format ID line

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeEmblDE

Extract words from an EMBL DE line

Synopsis

Prototype

void embBtreeEmblDE (
      const AjPStr deline,
      AjPList delist,
      ajuint maxlen
);

Type Name Read/Write Description

const AjPStr deline Input description line

AjPList delist Output list of descriptions

ajuint maxlen Input max keyword length

void RETURN

Input

deline:	(Input)	description line
maxlen:	(Input)	max keyword length

Output

delist:

(Output)

list of descriptions

Returns

void:

No return value

Description

Extract words from an EMBL DE line

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeGenBankAC

Extract accession numbers from a GenBank ACCESSION line

Synopsis

Prototype

void embBtreeGenBankAC (
      const AjPStr acline,
      AjPList aclist
);

Type Name Read/Write Description

const AjPStr acline Input AC line

AjPList aclist Output list of accession numbers

void RETURN

Input

acline:

(Input)

AC line

Output

aclist:

(Output)

list of accession numbers

Returns

void:

No return value

Description

Extract accession numbers from a GenBank ACCESSION line

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeGenBankKW

Extract keywords from a GenBank KEYWORDS line

Synopsis

Prototype

void embBtreeGenBankKW (
      const AjPStr kwline,
      AjPList kwlist,
      ajuint maxlen
);

Type Name Read/Write Description

const AjPStr kwline Input keyword line

AjPList kwlist Output list of keywords

ajuint maxlen Input max keyword length

void RETURN

Input

kwline:	(Input)	keyword line
maxlen:	(Input)	max keyword length

Output

kwlist:

(Output)

list of keywords

Returns

void:

No return value

Description

Extract keywords from a GenBank KEYWORDS line

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeGenBankDE

Extract keywords from a GenBank DESCRIPTION line

Synopsis

Prototype

void embBtreeGenBankDE (
      const AjPStr kwline,
      AjPList kwlist,
      ajuint maxlen
);

Type Name Read/Write Description

const AjPStr kwline Input keyword line

AjPList kwlist Output list of keywords

ajuint maxlen Input max keyword length

void RETURN

Input

kwline:	(Input)	keyword line
maxlen:	(Input)	max keyword length

Output

kwlist:

(Output)

list of keywords

Returns

void:

No return value

Description

Extract keywords from a GenBank DESCRIPTION line

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeGenBankTX

Extract keywords from a GenBank ORGANISM line

Synopsis

Prototype

void embBtreeGenBankTX (
      const AjPStr kwline,
      AjPList kwlist,
      ajuint maxlen
);

Type Name Read/Write Description

const AjPStr kwline Input keyword line

AjPList kwlist Output list of keywords

ajuint maxlen Input max keyword length

void RETURN

Input

kwline:	(Input)	keyword line
maxlen:	(Input)	max keyword length

Output

kwlist:

(Output)

list of keywords

Returns

void:

No return value

Description

Extract keywords from a GenBank ORGANISM line

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeFastaDE

Extract keywords from a Fasta description

Synopsis

Prototype

void embBtreeFastaDE (
      const AjPStr kwline,
      AjPList kwlist,
      ajuint maxlen
);

Type Name Read/Write Description

const AjPStr kwline Input keyword line

AjPList kwlist Output list of keywords

ajuint maxlen Input max keyword length

void RETURN

Input

kwline:	(Input)	keyword line
maxlen:	(Input)	max keyword length

Output

kwlist:

(Output)

list of keywords

Returns

void:

No return value

Description

Extract keywords from a Fasta description

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeFastaSV

Extract sequence version keywords from a Fasta description

Synopsis

Prototype

void embBtreeFastaSV (
      const AjPStr kwline,
      AjPList kwlist,
      ajuint maxlen
);

Type Name Read/Write Description

const AjPStr kwline Input sequence version or GI string

AjPList kwlist Output list of sequence versions

ajuint maxlen Input max sequence version length

void RETURN

Input

kwline:	(Input)	sequence version or GI string
maxlen:	(Input)	max sequence version length

Output

kwlist:

(Output)

list of sequence versions

Returns

void:

No return value

Description

Extract sequence version keywords from a Fasta description

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeReadDir

Read files to index

Synopsis

Prototype

ajuint embBtreeReadDir (
      AjPStr** filelist,
      const AjPStr fdirectory,
      const AjPStr files,
      const AjPStr exclude
);

Type Name Read/Write Description

AjPStr** filelist Output list of files to read

const AjPStr fdirectory Input Directory to scan

const AjPStr files Input Filename to search for (or NULL)

const AjPStr exclude Input list of files to exclude

ajuint RETURN number of matching files

Input

fdirectory:	(Input)	Directory to scan
files:	(Input)	Filename to search for (or NULL)
exclude:	(Input)	list of files to exclude

Output

filelist:

(Output)

list of files to read

Returns

ajuint:

number of matching files

Description

Read files to index

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeEntryNew

Construct a database entry object

Synopsis

Prototype

EmbPBtreeEntry embBtreeEntryNew (
      void
);

Type Name Read/Write Description

EmbPBtreeEntry RETURN db entry object pointer

Returns

EmbPBtreeEntry:

db entry object pointer

Description

Construct a database entry object

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeEntryDel

Delete a database entry object

Synopsis

Prototype

void embBtreeEntryDel (
      EmbPBtreeEntry* thys
);

Type Name Read/Write Description

EmbPBtreeEntry* thys Delete db entry object pointer

void RETURN

Output

thys:

(Delete)

db entry object pointer

Returns

void:

No return value

Description

Delete a database entry object

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeEntrySetCompressed

Set database entry to be compressed on writing

Synopsis

Prototype

void embBtreeEntrySetCompressed (
      EmbPBtreeEntry entry
);

Type Name Read/Write Description

EmbPBtreeEntry entry Modify Database entry information

void RETURN

Input & Output

entry:

(Modify)

Database entry information

Returns

void:

No return value

Description

Set database entry to be compressed on writing

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeSetFields

Set database fields to index

Synopsis

Prototype

ajuint embBtreeSetFields (
      EmbPBtreeEntry entry,
      AjPStr const* fields
);

Type Name Read/Write Description

EmbPBtreeEntry entry Output Database entry information

AjPStr const* fields Input user specified fields

ajuint RETURN number of fields set

Input

fields:

(Input)

user specified fields

Output

entry:

(Output)

Database entry information

Returns

ajuint:

number of fields set

Description

Set database fields to index

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeSetDbInfo

Set general database information

Synopsis

Prototype

void embBtreeSetDbInfo (
      EmbPBtreeEntry entry,
      const AjPStr name,
      const AjPStr dbrs,
      const AjPStr date,
      const AjPStr release,
      const AjPStr type,
      const AjPStr directory,
      const AjPStr idirectory
);

Type Name Read/Write Description

EmbPBtreeEntry entry Output Database entry information

const AjPStr name Input user specified name

const AjPStr dbrs Input user specified resource

const AjPStr date Input user specified date

const AjPStr release Input user specified release

const AjPStr type Input user specified type

const AjPStr directory Input user specified directory

const AjPStr idirectory Input user specified index directory

void RETURN

Input

name:	(Input)	user specified name
dbrs:	(Input)	user specified resource
date:	(Input)	user specified date
release:	(Input)	user specified release
type:	(Input)	user specified type
directory:	(Input)	user specified directory
idirectory:	(Input)	user specified index directory

Output

entry:

(Output)

Database entry information

Returns

void:

No return value

Description

Set general database information

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeGetFieldC

Set database fields to index

Synopsis

Prototype

EmbPBtreeField embBtreeGetFieldC (
      EmbPBtreeEntry entry,
      const char* nametxt
);

Type Name Read/Write Description

EmbPBtreeEntry entry Output Database entry information

const char* nametxt Input Field name

EmbPBtreeField RETURN Btree index field definition

Input

nametxt:

(Input)

Field name

Output

entry:

(Output)

Database entry information

Returns

EmbPBtreeField:

Btree index field definition

Description

Set database fields to index

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeGetFieldS

Set database fields to index

Synopsis

Prototype

EmbPBtreeField embBtreeGetFieldS (
      EmbPBtreeEntry entry,
      const AjPStr name
);

Type Name Read/Write Description

EmbPBtreeEntry entry Output Database entry information

const AjPStr name Input Field name

EmbPBtreeField RETURN Btree index field definition

Input

name:

(Input)

Field name

Output

entry:

(Output)

Database entry information

Returns

EmbPBtreeField:

Btree index field definition

Description

Set database fields to index

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeGetFiles

Read files to index

Synopsis

Prototype

ajuint embBtreeGetFiles (
      EmbPBtreeEntry entry,
      const AjPStr fdirectory,
      const AjPStr files,
      const AjPStr exclude
);

Type Name Read/Write Description

EmbPBtreeEntry entry Modify list of files to read

const AjPStr fdirectory Input Directory to scan

const AjPStr files Input Filename to search for (or NULL)

const AjPStr exclude Input list of files to exclude

ajuint RETURN number of matching files

Input

fdirectory:	(Input)	Directory to scan
files:	(Input)	Filename to search for (or NULL)
exclude:	(Input)	list of files to exclude

Input & Output

entry:

(Modify)

list of files to read

Returns

ajuint:

number of matching files

Description

Read files to index

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeWriteEntryFile

Put files to entry file

Synopsis

Prototype

AjBool embBtreeWriteEntryFile (
      const EmbPBtreeEntry entry
);

Type Name Read/Write Description

const EmbPBtreeEntry entry Input database data

AjBool RETURN true on success

Input

entry:

(Input)

database data

Returns

AjBool:

true on success

Description

Put files to entry file

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeGetRsInfo

Get resource information for selected database

Synopsis

Prototype

void embBtreeGetRsInfo (
      EmbPBtreeEntry entry
);

Type Name Read/Write Description

EmbPBtreeEntry entry Modify database data

void RETURN

Input & Output

entry:

(Modify)

database data

Returns

void:

No return value

Description

Get resource information for selected database

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeOpenCaches

Open index files for writing

Synopsis

Prototype

AjBool embBtreeOpenCaches (
      EmbPBtreeEntry entry
);

Type Name Read/Write Description

EmbPBtreeEntry entry Modify database data

AjBool RETURN true on success

Input & Output

entry:

(Modify)

database data

Returns

AjBool:

true on success

Description

Open index files for writing

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeCloseCaches

Close index files

Synopsis

Prototype

AjBool embBtreeCloseCaches (
      EmbPBtreeEntry entry
);

Type Name Read/Write Description

EmbPBtreeEntry entry Modify database data

AjBool RETURN true on success

Input & Output

entry:

(Modify)

database data

Returns

AjBool:

true on success

Description

Close index files

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeProbeCaches

Close index files

Synopsis

Prototype

AjBool embBtreeProbeCaches (
      EmbPBtreeEntry entry
);

Type Name Read/Write Description

EmbPBtreeEntry entry Modify database data

AjBool RETURN true on success

Input & Output

entry:

(Modify)

database data

Returns

AjBool:

true on success

Description

Close index files

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeDumpParameters

Write index parameter files

Synopsis

Prototype

AjBool embBtreeDumpParameters (
      EmbPBtreeEntry entry
);

Type Name Read/Write Description

EmbPBtreeEntry entry Modify database data

AjBool RETURN true on success

Input & Output

entry:

(Modify)

database data

Returns

AjBool:

true on success

Description

Write index parameter files

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeFieldNewC

Constructor for a Btree index field

Synopsis

Prototype

EmbPBtreeField embBtreeFieldNewC (
      const char* nametxt
);

Type Name Read/Write Description

const char* nametxt Input Name

EmbPBtreeField RETURN Btree field

Input

nametxt:

(Input)

Name

Returns

EmbPBtreeField:

Btree field

Description

Constructor for a Btree index field

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeFieldNewS

Constructor for a Btree index field

Synopsis

Prototype

EmbPBtreeField embBtreeFieldNewS (
      const AjPStr name
);

Type Name Read/Write Description

const AjPStr name Input Name

EmbPBtreeField RETURN Btree field

Input

name:

(Input)

Name

Returns

EmbPBtreeField:

Btree field

Description

Constructor for a Btree index field

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeFieldDel

Destructor for a Btree index field

Synopsis

Prototype

void embBtreeFieldDel (
      EmbPBtreeField* Pthis
);

Type Name Read/Write Description

EmbPBtreeField* Pthis Delete Btree index field object

void RETURN

Output

Pthis:

(Delete)

Btree index field object

Returns

void:

No return value

Description

Destructor for a Btree index field

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeFieldSetCompressed

Set database field to be compressed on writing

Synopsis

Prototype

void embBtreeFieldSetCompressed (
      EmbPBtreeField field
);

Type Name Read/Write Description

EmbPBtreeField field Modify Database field information

void RETURN

Input & Output

field:

(Modify)

Database field information

Returns

void:

No return value

Description

Set database field to be compressed on writing

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeFieldSetIdtype

Set database field to be identifier type (not secondary) on writing

Synopsis

Prototype

void embBtreeFieldSetIdtype (
      EmbPBtreeField field
);

Type Name Read/Write Description

EmbPBtreeField field Modify Database field information

void RETURN

Input & Output

field:

(Modify)

Database field information

Returns

void:

No return value

Description

Set database field to be identifier type (not secondary) on writing

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embBtreeFieldSetSecondary

Set database field to be secondary on writing

Synopsis

Prototype

void embBtreeFieldSetSecondary (
      EmbPBtreeField field
);

Type Name Read/Write Description

EmbPBtreeField field Modify Database field information

void RETURN

Input & Output

field:

(Modify)

Database field information

Returns

void:

No return value

Description

Set database field to be secondary on writing

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Function embIndexExit

Cleanup indexing internals on exit

Synopsis

Prototype

void embIndexExit (
      void
);

Type Name Read/Write Description

void RETURN

Returns

void:

No return value

Description

Cleanup indexing internals on exit

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

Availability

In release 6.4.0

Type	Name	Read/Write	Description
const AjPStr	deline	Input	description line
AjPList	delist	Output	list of descriptions
ajuint	maxlen	Input	max keyword length
void		RETURN

Type	Name	Read/Write	Description
AjPStr**	filelist	Output	list of files to read
const AjPStr	fdirectory	Input	Directory to scan
const AjPStr	files	Input	Filename to search for (or NULL)
const AjPStr	exclude	Input	list of files to exclude
ajuint		RETURN	number of matching files

Type	Name	Read/Write	Description
EmbPBtreeField*	Pthis	Delete	Btree index field object
void		RETURN

embindex.c

Synopsis

Prototype

Input

Input & Output

Returns

Description

Usage

Example

Errors

Dependencies

See Also

Availability

Synopsis

Prototype

Input

Input & Output

Returns

Description

Usage

Example

Errors

Dependencies

See Also

Availability

Synopsis

Prototype

Input

Input & Output

Returns

Description

Usage

Example

Errors

Dependencies

See Also

Availability

Synopsis

Prototype

Input

Input & Output

Returns

Description

Usage

Example

Errors

Dependencies

See Also

Availability

Synopsis

Prototype

Input

Input & Output

Returns

Description

Usage

Example

Errors

Dependencies

See Also

Availability

Synopsis

Prototype

Input

Input & Output

Returns

Description

Usage

Example

Errors

Dependencies

See Also

Availability

Synopsis

Prototype

Input

Input & Output

Returns

Description

Usage