Module

IMu.Module

IMu.Module

Depuis : 1.0

Description

Permet d'accéder à un module EMu.

Constructeurs

Constructeur

Détails

Module(table, session)

Module(string table, Session session)

Crée un objet qui peut être utilisé pour accéder au module EMu spécifié par table.

Paramètres :

table (string)

Nom du module EMu auquel il faut accéder.

session (Session)

Un objet Session à utiliser pour communiquer avec le serveur IMu.

Module(table)

Module(string table)

Crée un objet qui peut être utilisé pour accéder au module EMu spécifié par table et les valeurs par défaut host et port de la classe Session.

Paramètres :

table (string)

Nom du module EMu auquel il faut accéder.

Propriétés

Propriété

Détails
Table

string Table

Le nom de la table associée à l'objet Module.

Méthodes

Méthode

Détails

AddFetchSet(name, columns)

int AddFetchSet(string name, string columns)

Associe un ensemble de colonnes à un nom logique sur le serveur. Le nom peut être utilisé à la place d’une liste de colonnes lors de la récupération des données à l’aide de Fetch( ).

Paramètres :

name (string)

Nom logique à associer à l'ensemble de colonnes.

columns (string)

Une string contenant les noms des colonnes à utiliser lorsque name est passé à Fetch( ). Les noms des colonnes doivent être séparés par un semi-colon ou un comma.

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

AddFetchSet(name, columns)

int AddFetchSet(string name, string[] columns)

Associe un ensemble de colonnes à un nom logique sur le serveur. Le nom peut être utilisé à la place d’une liste de colonnes lors de la récupération des données à l’aide de Fetch( ).

Paramètres :

name (string)

Nom logique à associer à l'ensemble de colonnes.

columns (string[])

Un tableau de strings contenant les noms des colonnes à utiliser lorsque name est passé à Fetch( ).

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

AddFetchSet(name, columns)

int AddFetchSet(string name, List<string> columns)

Associe un ensemble de colonnes à un nom logique sur le serveur. Le nom peut être utilisé à la place d’une liste de colonnes lors de la récupération des données à l’aide de Fetch( ).

Paramètres :

name (string)

Nom logique à associer à l'ensemble de colonnes.

columns (List<string>)

Une liste de strings contenant les noms des colonnes à utiliser lorsque name est passé à Fetch( ).

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

AddFetchSets(sets)

int AddFetchSets(Map sets)

Associe plusieurs ensembles de colonnes à des noms logiques sur le serveur.

C’est l’équivalent d’appeler AddFetchSet( ) pour chaque entrée de la Map, mais c’est plus efficace.

Paramètres :

sets (Map)

Un Map contenant un ensemble de correspondances entre un nom et un ensemble de colonnes.

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

AddSearchAlias(name, columns)

int AddSearchAlias(string name, string columns)

Associe un ensemble de colonnes à un nom logique sur le serveur.

Le nom peut être utilisé pour spécifier les termes de recherche à transmettre à FindTerms( ). La recherche devient l’équivalent d’une recherche OR impliquant les colonnes.

Paramètres :

name (string)

Nom logique à associer à l'ensemble de colonnes.

columns (string)

Une string contenant les noms des colonnes à utiliser lorsque name est passé à FindTerms( ). Les noms des colonnes doivent être séparés par un semi-colon ou un comma.

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

AddSearchAlias(name, columns)

int AddSearchAlias(string name, string[] columns)

Associe un ensemble de colonnes à un nom logique sur le serveur.

Le nom peut être utilisé pour spécifier les termes de recherche à transmettre à FindTerms( ). La recherche devient l’équivalent d’une recherche OR impliquant les colonnes.

Paramètres :

name (string)

Nom logique à associer à l'ensemble de colonnes.

columns (string[])

Un tableau de strings contenant les noms des colonnes à utiliser lorsque name est passé à FindTerms( ).

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

AddSearchAlias(name, columns)

int AddSearchAlias(string name, List<string> columns)

Associe un ensemble de colonnes à un nom logique sur le serveur.

Le nom peut être utilisé pour spécifier les termes de recherche à transmettre à FindTerms( ). La recherche devient l’équivalent d’une recherche OR impliquant les colonnes.

Paramètres :

name (string)

Nom logique à associer à l'ensemble de colonnes.

columns (List<string>)

Une liste de strings contenant les noms des colonnes à utiliser lorsque name est passé à FindTerms( ).

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

AddSearchAliases(aliases)

int AddSearchAliases(Map aliases)

Associe un ensemble de colonnes à un nom logique sur le serveur.

C’est l’équivalent d’appeler AddSearchAlias( ) pour chaque entrée de la Map, mais c’est plus efficace.

Paramètres :

aliases (Map)

Un Map contenant un ensemble de correspondances entre un nom et un ensemble de colonnes.

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

AddSortSet(name, keys)

int AddSortSet(string name, string keys)

Associe un ensemble de clés de tri à un nom logique sur le serveur.

Le nom peut être utilisé à la place d’une liste de clés de tri lors du tri du jeu de résultats actuel à l’aide de Sort( ).

Paramètres :

name (string)

Nom logique à associer à l'ensemble de colonnes.

keys (string)

Une string contenant les noms des clés à utiliser lorsque name est passé à Sort( ). Les clés doivent être séparées par un semi-colon ou une comma.

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

AddSortSet(name, keys)

Associe un ensemble de clés de tri à un nom logique sur le serveur.

int AddSortSet(string name, string[] keys)

Associe un ensemble de clés de tri à un nom logique sur le serveur.

Paramètres :

name (string)

Nom logique à associer à l'ensemble de colonnes.

keys (string[])

Un tableau de strings contenant les noms des clés à utiliser lorsque name est passé à Sort( ). Les clés doivent être séparées par un semi-colon ou une comma.

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

AddSortSet(name, keys)

int AddSortSet(string name, List<string> keys)

Associe un ensemble de clés de tri à un nom logique sur le serveur.

Paramètres :

name (string)

Nom logique à associer à l'ensemble de colonnes.

keys (List<string>)

Une liste de strings contenant les noms des clés à utiliser lorsque name est passé à Sort( ). Les clés doivent être séparées par un semi-colon ou une comma.

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

AddSortSets(sets)

Associe plusieurs ensembles de clés de tri à des noms logiques sur le serveur.

int AddSortSets(Map sets)

Associe plusieurs ensembles de clés de tri à des noms logiques sur le serveur.

C’est l’équivalent d’appeler AddSortSet( ) pour chaque entrée de la Map, mais c’est plus efficace.

Paramètres :

sets (Map)

Un Map contenant un ensemble de correspondances entre un nom et un ensemble de clés.

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

Fetch(flag, offset, count, columns)

ModuleFetchResult Fetch(string flag, long offset, int count, string columns)

Récupère count les enregistrements à partir de la position décrite par une combinaison de flag et offset.

Paramètres :

flag (string)

La position à partir de laquelle commencer à récupérer les enregistrements. Doit être l'un des éléments suivants : start, current, end

offset (long)

La position par rapport à flag à partir de laquelle commencer la récupération.

count (int)

Le nombre d’enregistrements à récupérer. Un count de 0 est autorisé pour changer l’emplacement de l’enregistrement en cours sans renvoyer de résultats. Un count inférieur à 0 entraîne le renvoi de tous les enregistrements restants dans le jeu de résultats.

columns (string)

 

Une string contenant les noms des colonnes à retourner pour chaque enregistrement ou le nom d’un ensemble de colonnes qui a été enregistré précédemment en utilisant AddFetchSet( ). Les noms des colonnes doivent être séparés par un semi-colon ou un comma.

Retourne :

ModuleFetchResult

Un objet ModuleFetchResult.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

Fetch(flag, offset, count, columns)

ModuleFetchResult Fetch(string flag, long offset, int count, string[] columns)

Récupère count les enregistrements à partir de la position décrite par une combinaison de flag et offset.

Paramètres :

flag (string)

La position à partir de laquelle commencer à récupérer les enregistrements. Doit être l'un des éléments suivants : start, current, end

offset (long)

La position par rapport à flag à partir de laquelle commencer la récupération.

count (int)

Le nombre d’enregistrements à récupérer. Un count de 0 est autorisé pour changer l’emplacement de l’enregistrement en cours sans renvoyer de résultats. Un count inférieur à 0 entraîne le renvoi de tous les enregistrements restants dans le jeu de résultats.

columns (string[])

 

Un tableau de strings contenant les noms des colonnes à retourner pour chaque enregistrement ou le nom d’un ensemble de colonnes qui a été enregistré précédemment en utilisant AddFetchSet( ).

Retourne :

ModuleFetchResult

Un objet ModuleFetchResult.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

Fetch(flag, offset, count, columns)

ModuleFetchResult Fetch(string flag, long offset, int count, List<string> columns)

Récupère count les enregistrements à partir de la position décrite par une combinaison de flag et offset.

Paramètres :

flag (string)

La position à partir de laquelle commencer à récupérer les enregistrements. Doit être l'un des éléments suivants : start, current, end

offset (long)

La position par rapport à flag à partir de laquelle commencer la récupération.

count (int)

Le nombre d’enregistrements à récupérer. Un count de 0 est autorisé pour changer l’emplacement de l’enregistrement en cours sans renvoyer de résultats. Un count inférieur à 0 entraîne le renvoi de tous les enregistrements restants dans le jeu de résultats.

columns (List<string>)

Une liste de strings contenant les noms des colonnes à retourner pour chaque enregistrement ou le nom d’un ensemble de colonnes qui a été enregistré précédemment en utilisant AddFetchSet( ).

Retourne :

ModuleFetchResult

Un objet ModuleFetchResult.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

Fetch(flag, offset, count)

ModuleFetchResult Fetch(string flag, long offset, int count)

Récupère count les enregistrements à partir de la position décrite par une combinaison de flag et offset.

Paramètres :

flag (string)

La position à partir de laquelle commencer à récupérer les enregistrements. Doit être l'un des éléments suivants : start, current, end

offset (long)

La position par rapport à flag à partir de laquelle commencer la récupération.

count (int)

Le nombre d’enregistrements à récupérer. Un count de 0 est autorisé pour changer l’emplacement de l’enregistrement en cours sans renvoyer de résultats. Un count inférieur à 0 entraîne le renvoi de tous les enregistrements restants dans le jeu de résultats.

Retourne :

ModuleFetchResult

Un objet ModuleFetchResult.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

FindKey(key)

long FindKey(long key)

Recherche un enregistrement avec la valeur clé key.

Paramètres :

key (long)

Clé de l’enregistrement recherché.

Retourne :

long

Le nombre d'enregistrements trouvés. Ce sera soit 1 si l’enregistrement a été trouvé, soit 0 s’il n’a pas été trouvé.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

FindKeys(keys)

long FindKeys(long[] keys)

Recherche les enregistrements avec des valeurs clés dans le tableau keys.

Paramètres :

keys (long[])

La liste des clés recherchées.

Retourne :

long

Le nombre d’enregistrements trouvés.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

FindKeys(keys)

long FindKeys(List<long> keys)

Recherche les enregistrements avec des valeurs clés dans le tableau keys.

Paramètres :

keys (List<long>)

Un tableau de clés recherchées.

Retourne :

long

Le nombre d'enregistrements trouvés.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

FindTerms(terms)

long FindTerms(Terms terms)

Recherche les enregistrements qui correspondent aux termes de recherche spécifiés dans terms.

Paramètres :

terms (Terms)

Les termes de recherche.

Retourne :

long

Une estimation du nombre d’enregistrements trouvés.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

FindWhere(where)

long FindWhere(string where)

Recherche les enregistrements qui correspondent à la clause TexQL WHERE.

Paramètres :

where (string)

La clause TexQL WHERE à utiliser.

Retourne :

long

Une estimation du nombre d’enregistrements trouvés.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

RestoreFromFile(file)

long RestoreFromFile(string file)

Restaure un ensemble d’enregistrements à partir d’un fichier sur la machine serveur qui contient une liste de clés, une par ligne.

Paramètres :

file (string)

Le fichier sur la machine serveur contenant les clés.

Retourne :

long

Le nombre d'enregistrements trouvés.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

RestoreFromTemp(file)

long RestoreFromTemp(string file)

Restaure un ensemble d’enregistrements à partir d’un fichier temporaire sur la machine serveur qui contient une liste de clés, une par ligne. Fonctionne de la même manière que RestoreFromFile( ) sauf que le paramètre file est relatif au répertoire temporaire du serveur.

Paramètres :

file (string)

Le fichier sur la machine serveur contenant les clés.

Retourne :

long

Le nombre d'enregistrements trouvés.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

Sort(keys, flags)

ModuleSortResult Sort(string keys, string flags)

Trie le jeu de résultats en cours à l’aide des clés de tri dans keys. Chaque clé de tri est un nom de colonne éventuellement précédé d’un + (pour un tri croissant) ou d’un - (pour un tri décroissant).

Paramètres :

keys (string)

Une string contenant la liste des clés de tri. Les clés doivent être séparées par un semi-colon ou une comma.

flags (string)

Une string contenant un ensemble d’indicateurs spécifiant le comportement du tri. Les indicateurs doivent être séparés par un point-virgule ou une virgule.

Retourne :

ModuleSortResult

Un objet ModuleSortResult. Si l'indicateur report n'a pas été spécifié, le résultat sera null.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

Sort(keys, flags)

ModuleSortResult Sort(string keys, string[] flags)

Trie le jeu de résultats en cours à l’aide des clés de tri dans keys. Chaque clé de tri est un nom de colonne éventuellement précédé d’un + (pour un tri croissant) ou d’un - (pour un tri décroissant).

Paramètres :

keys (string)

Une string contenant la liste des clés de tri. Les clés doivent être séparées par un semi-colon ou une comma.

flags (string[])

Un tableau de strings spécifiant le comportement du tri.

Retourne :

ModuleSortResult

Un objet ModuleSortResult. Si l'indicateur report n'a pas été spécifié, le résultat sera null.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

Sort(keys, flags)

ModuleSortResult Sort(string keys, List<string> flags)

Trie le jeu de résultats en cours à l’aide des clés de tri dans keys. Chaque clé de tri est un nom de colonne éventuellement précédé d’un + (pour un tri croissant) ou d’un - (pour un tri décroissant).

Paramètres :

keys (string)

Une string contenant la liste des clés de tri. Les clés doivent être séparées par un semi-colon ou une comma.

flags (List<string>)

Une liste de strings spécifiant le comportement du tri.

Retourne :

ModuleSortResult

Un objet ModuleSortResult. Si l'indicateur report n'a pas été spécifié, le résultat sera null.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

Sort(keys, flags)

ModuleSortResult Sort(string[] keys, string flags)

Trie le jeu de résultats en cours à l’aide des clés de tri dans keys. Chaque clé de tri est un nom de colonne éventuellement précédé d’un + (pour un tri croissant) ou d’un - (pour un tri décroissant).

Paramètres :

keys (string[])

Un tableau de strings contenant la liste des clés de tri.

flags (string)

Une string contenant un ensemble d’indicateurs spécifiant le comportement du tri. Les indicateurs doivent être séparés par un semi-colon ou une comma.

Retourne :

ModuleSortResult

Un objet ModuleSortResult. Si l'indicateur report n'a pas été spécifié, le résultat sera null.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

Sort(keys, flags)

ModuleSortResult Sort(string[] keys, string[] flags)

Trie le jeu de résultats en cours à l’aide des clés de tri dans keys. Chaque clé de tri est un nom de colonne éventuellement précédé d’un + (pour un tri croissant) ou d’un - (pour un tri décroissant).

Paramètres :

keys (string[])

Un tableau de strings contenant la liste des clés de tri.

flags (string[])

Un tableau de strings spécifiant le comportement du tri.

Retourne :

ModuleSortResult

Un objet ModuleSortResult. Si l'indicateur report n'a pas été spécifié, le résultat sera null.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

Sort(keys, flags)

ModuleSortResult Sort(string[] keys, List<string> flags)

Trie le jeu de résultats en cours à l’aide des clés de tri dans keys.

Chaque clé de tri est un nom de colonne éventuellement précédé d’un + (pour un tri croissant) ou d’un - (pour un tri décroissant).

Paramètres :

keys (string[])

Un tableau de strings contenant la liste des clés de tri.

flags (List<string>)

Une liste de strings spécifiant le comportement du tri.

Retourne :

ModuleSortResult

Un objet ModuleSortResult. Si l'indicateur report n'a pas été spécifié, le résultat sera null.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

Sort(keys, flags)

ModuleSortResult Sort(List<string> keys, string flags)

Trie le jeu de résultats en cours à l’aide des clés de tri dans keys. Chaque clé de tri est un nom de colonne éventuellement précédé d’un + (pour un tri croissant) ou d’un - (pour un tri décroissant).

Paramètres :

keys (List<string>)

Une liste de strings contenant la liste des clés de tri.

flags (string)

Une string contenant un ensemble d’indicateurs spécifiant le comportement du tri. Les indicateurs doivent être séparés par un semi-colon ou une comma.

Retourne :

ModuleSortResult

Un objet ModuleSortResult. Si l'indicateur report n'a pas été spécifié, le résultat sera null.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

Sort(keys, flags)

ModuleSortResult Sort(List<string> keys, string[] flags)

Trie le jeu de résultats en cours à l’aide des clés de tri dans keys. Chaque clé de tri est un nom de colonne éventuellement précédé d’un + (pour un tri croissant) ou d’un - (pour un tri décroissant).

Paramètres :

keys (List<string>)

Une liste de strings contenant la liste des clés de tri.

flags (string[])

Un tableau de strings spécifiant le comportement du tri.

Retourne :

ModuleSortResult

Un objet ModuleSortResult. Si l'indicateur report n'a pas été spécifié, le résultat sera null.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

Sort(keys, flags)

ModuleSortResult Sort(List<string> keys, List<string> flags)

Trie le jeu de résultats en cours à l’aide des clés de tri dans keys. Chaque clé de tri est un nom de colonne éventuellement précédé d’un + (pour un tri croissant) ou d’un - (pour un tri décroissant).

Paramètres :

keys (List<string>)

Une liste de strings contenant la liste des clés de tri.

flags (List<string>)

Une liste de strings spécifiant le comportement du tri.

Retourne :

ModuleSortResult

Un objet ModuleSortResult. Si l'indicateur report n'a pas été spécifié, le résultat sera null.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.