APERCU DES FONCTIONS

(Sauf obsolètes et expérimentales)

 

Réalisé à partir de la liste des fonctions modifiée à la date du présent document  pour la dernière fois le 2008/12/09 18:44:04 UTC et détaillées ici : http://www.sqlite.org/c3ref/funclist.html

 

sqlite3_aggregate_context

Implémentation de fonction d'agrégats

 

sqlite3_auto_extension

Registration d'extensions qui seront invoquées lors de chaque connexion à la base de donnée (=open, open16, open_v2)

 

sqlite3_bind_*

Remplacement (Bind=Lier) des variables déclarées lors de la préparation d'une requête SQL par leur contenu.

Utilisable uniquement si la préparation de la requête a été faite au moyen de la fonction prepare_v2.

Doit être utilisé avant la fonction step.

Les variables peuvent être déclarées ainsi qu'il suit :

? -> Type indéfini

?nom_de_variable -> Type Integer

:nom_de_variable -> type alpha-numeric

@nom_de_variable -> type alpha-numeric

$nom_de_variable -> type alpha-numeric

 

sqlite3_clear_bindings

Réinitialise toutes les variables des requêtes SQL (A noter que la fonction reset ne réinitialise pas lesdites variables).

 

sqlite3_bind_parameter_count

Retourne le nombre de variables trouvées dans une requête SQL

 

sqlite3_bind_parameter_index

Retourne l'index d'une variable déclarée dans une requête SQL à partir de son nom (Cet index est utilisé dans les fonctions sqlite3_bind_*)

 

sqlite3_bind_parameter_name

Retourne le nom (sous forme de pointer) d'une variable déclarée dans une requête SQL à partir de son index

 

sqlite3_blob_*

Taille/fermeture/ouverture/lecture/ecriture d'un blob

 

sqlite3_busy_handler

Défini la fonction à appeler dans le cas où l'ouverture d'une base ou d'une table se heurte à un thread déjà ouvert ou à un process verrouillé.

Par défaut, il n'existe aucune fonction, et code SQLITE_BUSY or SQLITE_IOERR_BLOCKED sont directement retournés.

 

sqlite3_busy_timeout

Détermine le temps d'attente au cas où une table serait verrouillée.

 

sqlite3_changes

Retourne le nombre d'enregistrements modifiés, ajoutés ou supprimés par la dernière requête SQL. (Ne prend pas en compte les modifications de triggers).

 

sqlite3_close

Destruction du pointer de connexion à la base de donnée (Pointer créé à partir de la fonction open)

 

sqlite3_column_*

Retourne pour un champs donné (=colonne) le résultat d'une requête (Ne retourne une valeur que si la fonction step renvoi SQLITE_ROW)

 

sqlite3_column_type

Retourne le type du résultat de la requête (SQLITE_INTEGER, SQLITE_FLOAT, SQLITE_TEXT, SQLITE_BLOB, ou SQLITE_NULL)

 

sqlite3_column_count

Retourne le nombre de colonnes contenu dans le résultat d'une requête.

 

sqlite3_column_database_name

sqlite3_column_database_name16

Retourne le nom d'une colonne donnée.

 

sqlite3_column_decltype

sqlite3_column_decltype16

?????

 

sqlite3_column_name

sqlite3_column_name16

sqlite3_column_origin_name

sqlite3_column_origin_name16

sqlite3_column_table_name

sqlite3_column_table_name16

Retourne le nom de la colonne ou de la table ou de la base de donnée à partir desquels est obtenue le résultat d'une requête SQL.

 

sqlite3_column_value

?????

 

sqlite3_commit_hook

Défini la fonction à appeler chaque fois q'une transaction avec la base de donnée est commencée.

 

sqlite3_rollback_hook

Défini la fonction à appeler chaque fois q'une transaction avec la base de donnée est validée.

 

sqlite3_complete

sqlite3_complete16

Vérifie si une requête SQL est syntaxiquement complète.

 

sqlite3_context_db_handle

Retourne une copie du pointer de la base de donnée d'une fonction créée donnée.

 

sqlite3_create_collation

sqlite3_create_collation16

sqlite3_create_collation_v2

Permet d'ajouter une séquence de tri à la base de donnée.

 

sqlite3_collation_needed

sqlite3_collation_needed16

????? (Enregistrement des séquences de tri)

 

sqlite3_create_function

sqlite3_create_function16

Permet d'ajouter une fonction SQL simple ou d'agrégat

 

sqlite3_data_count

Retourne le nombre de champs contenus dans l'enregistrement courant

 

sqlite3_db_handle

Retourne le pointer de la base de donnée à partir de laquelle une requête SQL a été exécutée.

 

sqlite3_db_mutex

sqlite3_mutex_alloc

sqlite3_mutex_enter

sqlite3_mutex_free

sqlite3_mutex_try

sqlite3_mutex_leave

sqlite3_mutex_held

sqlite3_mutex_notheld

sqlite3_threadsafe

????? (Multi-thread)

 

sqlite3_enable_load_extension

Activation de chargement d'extension (Désactivé par défaut | 0 = non / 1 = oui)

 

sqlite3_enable_shared_cache

Activation du partage de la base de donnée (Activé par défaut)

 

sqlite3_errcode

sqlite3_extended_errcode

Retourne le code d'erreur de la dernière erreur rencontrée lors de l'utilisation d'une fonction sqlite3_*

 

sqlite3_errmsg

sqlite3_errmsg16

Retourne la description du message d'erreur (En anglais)

 

sqlite3_exec

Exécution d'une ou plusieurs instructions SQL

 

sqlite3_extended_result_codes

Activation des codes d'erreur étendus (Désactivé par défaut)

 

sqlite3_file_control

?????

 

sqlite3_finalize

Destruction du pointer de requête (Pointer créé à partir de la fonction prepare)

 

sqlite3_malloc

sqlite3_realloc

sqlite3_free

sqlite3_memory_highwater

sqlite3_memory_used

sqlite3_soft_heap_limit

???? (Fonctions de gestion de la mémoire)

 

sqlite3_release_memory

????? (Libération de la mémoire non essentielle)

 

sqlite3_get_table

Retourne une table sous forme de array of pointers.

C'est fonction est un wrapper de la fonction sqlite_exec

 

sqlite3_free_table

Destruction (en mémoire) de la table créée à partir de la fonction get_table

 

sqlite3_get_autocommit

Activation de l'exécution automatique des requêtes (Activé par défaut)

Désactivation : Par l'instruction SQL BEGIN

Activation : Par l'instruction SQL COMMIT ou ROLLBACK

 

sqlite3_get_auxdata

sqlite3_set_auxdata

?????

 

sqlite3_initialize

sqlite3_shutdown

sqlite3_os_init

sqlite3_os_end

Initialisation.Désinitialisation de la dll

Fonction appelée en interne par beaucoup d'autres fonctions. Un programme développé autour de la dll sqlite3 ne devrait pas avoir besoin de l'initialiser directement.

 

sqlite3_interrupt

Annulation des requêtes en cours d'exécution

 

sqlite3_last_insert_rowid

Retourne le numéro ROWID du dernier enregistrement ajouté à la base de donnée au moyen de l'instruction SQL INSERT

A noter qu'à chaque enregistrement est attribué un numéro incrémental unique d'identification appelé ROWID et accessible depuis n'importe quelle requête SQL sous cette même dénomination ROWID

 

sqlite3_libversion

sqlite3_libversion_number

sqlite3_version

Retourne le numéro de version de la dll (Sous forme de String ou d'Integer)

 

sqlite3_limit

????? (Limitation relative à la connexion à la base de donnée --> LENGTH, SQL_LENGTH, LIMIT_COLUMN, EXPR_DEPTH, COMPOUND_SELECT, VDBE_OP, FUNCTION_ARG, ATTACHED, LIKE_PATTERN_LENGTH, VARIABLE_NUMBER)

 

sqlite3_load_extension

????? (Chargement d'une autre dll externe)

 

sqlite3_reset_auto_extension

Déchargement de toute les extensions.

 

sqlite3_mprintf

sqlite3_snprintf

sqlite3_vmprintf

????? (Affichage/Ecriture de message lors de l'utilisation de la dll sous forme de console)

 

sqlite3_next_stmt

Retourne le pointer du prochain enregistrement (ou du premier si l'enregistrement courant est le dernier) obtenu avec la fonction prepare

 

sqlite3_open

sqlite3_open16

sqlite3_open_v2

Ouverture d'une base de donnée sqlite. Affecte un pointer d'identification de la base.

La fonction open_v2 permet de définir des options d'ouverture de la base de donnée.

Deux options peuvent être définies :

• Celles relatives au Mutex (????? Multi-thread)  :

- SQLITE_OPEN_NOMUTEX : ????? (Pas de Multi-thread)

- SQLITE_OPEN_FULLMUTEX : ????? (Multi-thread)

• Celles relatives aux droits conférés à l'utilisateur

- SQLITE_OPEN_READONLY : Lecture seule (Si la base n'existe pas elle n'est pas créée)

- SQLITE_OPEN_READWRITE : Lecture et écriture (Si la base n'existe pas elle n'est pas créée)

- SQLITE_OPEN_CREATE : Lecture et écriture (Si la base n'existe pas elle est créée – C'est dans ce mode qu'est ouvert une base avec les fonctions open ou open16)

- SQLITE_OPEN_DELETEONCLOSE : ?????

- SQLITE_OPEN_EXCLUSIVE : ?????

- SQLITE_OPEN_MAIN_DB : ?????

- SQLITE_OPEN_TEMP_DB : ?????

- SQLITE_OPEN_TRANSIENT_DB : ?????

- SQLITE_OPEN_MAIN_JOURNAL : ?????

- SQLITE_OPEN_TEMP_JOURNAL : ?????

- SQLITE_OPEN_SUBJOURNAL : ?????

- SQLITE_OPEN_MASTER_JOURNAL : ?????

Si la base de donnée a pour nom ":memory", il est alors créé en mémoire une base de donnée privée temporaire.

Si le nom de la base de donnée est laissé vide, il est alors créé sur le disque dur une base de donnée privée temporaire, effacée dès que la connexion à la base de donnée est fermée.

 

sqlite3_prepare

sqlite3_prepare16

sqlite3_prepare16_v2

sqlite3_prepare_v2

Permet la précompilation d'une instruction SQL en byte-code, préalable indispensable à l'exécution de toute requête.

Retourne le pointer vers la requête.

 

sqlite3_progress_handler

Défini la fonction à appeler périodiquement durant l'exécution d'une requête.

 

sqlite3_randomness

Générateur de nombre aléatoire.

 

sqlite3_reset

Réinitialisation d'une requête SQL.

Lorsqu'une requête SQL retourne plusieurs enregistrements ou valeur, la fonction reset permet de se repositionner avant le premier enregistrement.

 

sqlite3_result_*

Retourne la valeur d'un champs lors de l'exécution d'un fonction simple ou d'agrégat créée au moyen de la fonction create_function

 

sqlite3_set_authorizer

????? (Défini une fonction d'autorisation exécutée avant l'exécution des fonctions prepare)

 

sqlite3_sleep

Suspension d'exécution du thread en cours

 

sqlite3_sql

Retourne la dernière instruction SQL exécuton au moyen de la fonction prepare_v2

 

sqlite3_step

Déplacement sur l'enregistrement ou la valeur retourné par une requête.

Lorsqu'une requête SQL retourne plusieurs enregistrements ou valeurs, la fonction step permet lors de chaque appel de se positionner sur l'enregistrement ou la valeur suivante

 

sqlite3_table_column_metadata

?????

 

sqlite3_test_control

(Sans objet)

 

sqlite3_total_changes

Retourne le nombre d'enregistrement concerné par l'utilisation des fonctions SQL INSERT (ajout), UPDATE (modification) et DELETE (suppression) depuis que la connexion à la basse de donnée est ouverte.

 

sqlite3_update_hook

Défini une fonction appelée avant l'utilisation des fonctions SQL INSERT (ajout), UPDATE (modification) et DELETE (suppression)

 

sqlite3_user_data

????? (Utilisable à partir des fonctions create_fonction)

 

sqlite3_value_*

Retourne pour un champs donné le résultat d'une requête (Similaire aux fonctions column_* mais utilise un pointer de nature différente)

 

sqlite3_vfs_*

????? (virtual filesystem)