Show / Hide Table of Contents

Class FreeTextIndexTableInfo

Table 'freetextindex': This is the index table for the free text search function. Each word in FreeTextWords can have multiple occurrences in this table. Each record in this table points to one occurrence of the word, and points to both the table in which the word occurs (which might be contact or text), and also a pointer to the owner table (which is one of contact, person, project, appointment or sale).

Inheritance
Object
TableInfo
FreeTextIndexTableInfo
Implements
ICloneable
Inherited Members
TableInfo.ToString()
TableInfo.RegisterFields(FieldInfo[])
TableInfo.FieldInfoFromSoField(SoField)
TableInfo.Clone()
TableInfo.IsSameTable(TableInfo)
TableInfo.FindField(String)
TableInfo.ProtAll
TableInfo.HashCheckFields
TableInfo.TableName
TableInfo.DbName
TableInfo.IsDictionaryTable
TableInfo.All
TableInfo.Item[String]
TableInfo.PrimaryKeyField
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("freetextindex")]
public class FreeTextIndexTableInfo : TableInfo, ICloneable
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

Fields

DictionaryTableName

Conceptual name of table FreeTextIndex in the database dictionary: freetextindex

Declaration
public const string DictionaryTableName = "freetextindex"
Field Value
Type Description
String

Properties

ContactId

Field 'contact_id' in table 'freetextindex': Dictionary type FK, .NET type: Int32

Set for contacts and person records to allow cross-table free-text searches. 0 for non-contact, non-person

Declaration
public Int32FieldInfo ContactId { get; }
Property Value
Type Description
Int32FieldInfo

ContactId_InnerJoin_Contact

Generated join from the foreign key ContactId in this table, to its target table ContactTableInfo.

Declaration
public TargetedInnerJoin<ContactTableInfo> ContactId_InnerJoin_Contact { get; }
Property Value
Type Description
TargetedInnerJoin<ContactTableInfo>

Definition

Definition of the table as described in the deployed runtime dictionary

Declaration
public override SoTable Definition { get; }
Property Value
Type Description
SoTable
Overrides
TableInfo.Definition

DictionaryTableNumber

Table number for table FreeTextIndex in the database dictionary; potentially changes between databases, but always the same over the lifetime of any single database

Declaration
public int DictionaryTableNumber { get; }
Property Value
Type Description
Int32

FreetextindexId

Field 'freetextindex_id' in table 'freetextindex': Dictionary type PK, .NET type: Int32

Primary key

Declaration
public Int32FieldInfo FreetextindexId { get; }
Property Value
Type Description
Int32FieldInfo

FreetextwordsId

Field 'freetextwords_id' in table 'freetextindex': Dictionary type FK, .NET type: Int32

Reference to word

Declaration
public Int32FieldInfo FreetextwordsId { get; }
Property Value
Type Description
Int32FieldInfo

FreetextwordsId_InnerJoin_FreeTextWords

Generated join from the foreign key FreetextwordsId in this table, to its target table FreeTextWordsTableInfo.

Declaration
public TargetedInnerJoin<FreeTextWordsTableInfo> FreetextwordsId_InnerJoin_FreeTextWords { get; }
Property Value
Type Description
TargetedInnerJoin<FreeTextWordsTableInfo>

Infile

Field 'infile' in table 'freetextindex': Dictionary type UShort, .NET type: Int16

Word found in file (0=word found in database)

Declaration
public UInt16FieldInfo Infile { get; }
Property Value
Type Description
UInt16FieldInfo

OwnerrecordId

Field 'ownerrecord_id' in table 'freetextindex': Dictionary type RecordId, .NET type: Int32

Logical source record. The contact, project, sale that the source belongs to.

Declaration
public Int32FieldInfo OwnerrecordId { get; }
Property Value
Type Description
Int32FieldInfo

OwnertableId

Field 'ownertable_id' in table 'freetextindex': Dictionary type TableNumber, .NET type: Int16

Logical source table (high-level), like contact or project

Declaration
public UInt16FieldInfo OwnertableId { get; }
Property Value
Type Description
UInt16FieldInfo

RecordId

Field 'record_id' in table 'freetextindex': Dictionary type RecordId, .NET type: Int32

Source record - the row that contains the word. Might be contact record, or an address or phone

Declaration
public Int32FieldInfo RecordId { get; }
Property Value
Type Description
Int32FieldInfo

RuntimeDefinition

Definition of the table as described in the deployed runtime dictionary

Declaration
[Obsolete("Use instance property Definition or static member DictionaryTableNumber", true)]
public static SoTable RuntimeDefinition { get; }
Property Value
Type Description
SoTable

TableId

Field 'table_id' in table 'freetextindex': Dictionary type TableNumber, .NET type: Int16

Source table number - could be main (contact, person, etc) or sub-tables like address, email

Declaration
public UInt16FieldInfo TableId { get; }
Property Value
Type Description
UInt16FieldInfo

Methods

IdxFreetextwordsId(Int32)

Shortcut method for looking up using the database index FreetextwordsId, which spans the following fields:

FieldDescription
FreetextwordsIdReference to word
Declaration
public Restriction IdxFreetextwordsId(int freetextwordsId)
Parameters
Type Name Description
Int32 freetextwordsId
Returns
Type Description
Restriction

IdxTableId(Int16)

Shortcut method for looking up using the database index TableId, which spans the following fields:

FieldDescription
TableIdSource table number - could be main (contact, person, etc) or sub-tables like address, email
Declaration
public Restriction IdxTableId(short tableId)
Parameters
Type Name Description
Int16 tableId
Returns
Type Description
Restriction

Implements

System.ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top