octopus oc corelibs sql helpers

Cours d'aides PL / SQL

Outils pour le traitement automatique et la mise en forme du code PL / SQL

Limites

• Les fichiers multi-objets ne sont pas pris en charge. Cela signifie: un fichier - un objet avec instruction create . Le résultat du traitement des fichiers multi-objets est imprévisible, donc tous les outils (sauf STR_DECODER ) augmenteront une exception.
• Les noms d'objets doivent être donnés en utilisant uniquement les caractères ASCII .
• L'utilisation pour les définitions d'objets non soutenues augmentera également une exception. Les types d'objets pris en charge sont:
  • PROCÉDURE
  • FONCTION
  • EMBALLER
  • Carrosserie

Détails

str_decoder

La seule fonction decode_to_str essaie de détecter le codage des lignes et de le redécorer à UTF-8 . Soulève ValueError si le codage est impossible.

Synopsis

decode_to_str(line, probables=None)

• line - objet bytes avec un texte à décoder
• probables - list de str avec des encodages principaux à vérifier. Par défaut: ['cp866', 'cp1251', 'koi8-r']
• Valeur de retour - str (décodé et réencodé vers UTF-8 )

Utilisation de la ligne de commande

Décodage du fichier entier dans un autre fichier. Exécutez ceci pour obtenir la liste des arguments:

python -m oc_sql_helpers.str_decoder --help

emballage

La classe PLSQLWrapper est un outil pour travailler avec des sources enveloppées d'Oracle.

Exigences

Il existe des exigences supplémentaires pour envelopper des fichiers. Notez que les méthodes de déballage fonctionnent sans elle. Ceux-ci sont dus à l'utilisation de l'utilitaire wrap d'origine d' Oracle qui n'est pas inclus à ce package en raison de la violation de la licence . Vous devez l'installer séparément.

• La variable d'environnement ORACLE_HOME doit être définie correctement
• wrap le binaire doit être placé sous ${ORACLE_HOME}/bin et doit avoir une autorisation d'exécution pour un utilisateur efficace

Synopsis

PLSQLWrapper() - pour instancier un objet pour cette classe

Méthodes

• wrap_path(path_in, write_to=None)
  • path_in - str Objet avec un chemin absolu ou relatif à un fichier à envelopper.
  • write_to - un de:
    • None - le résultat d'enveloppe sera renvoyé par cette méthode comme objet bytes
    • file - Le résultat sera écrit dans l'objet de type fichier spécifié ici. Doit être ouvert en mode binaire en lecture ( 'w+b' ) et en fonctionnement seek .
    • str - chemin vers le fichier de sortie, absolu ou relatif. Le résultat y sera écrit. Doit avoir une extension - il s'agit de featre de l'utilitaire d'Oracle wrap . Il ajoute le suffixe .plb seul si une extension a omis. Veuillez spécifier toujours l'extension
  • Valeur de retour : voir write_to ci-dessus
• wrap_buf(fl_in, write_to=None)
  • fl_in - file ou un objet file-like pour envelopper les données. Doit être ouvert en mode binaire et en fonctionnement seek ( 'rb' ).
  • write_to - la même chose que pour wrap_path
  • Valeur de retour : la même chose que pour wrap_path
• unwrap_path(path_in, write_to=None)
  • path_in - str Objet avec un chemin absolu ou relatif pour le fichier pour se dérouler.
  • write_to - un de:
    • None - le résultat de déballage sera renvoyé par cette méthode comme objet bytes
    • file - Le résultat sera écrit dans l'objet de type fichier spécifié ici. Doit être ouvert en mode binaire en lecture ( 'w+b' ) et en fonctionnement seek .
    • str - chemin vers le fichier de sortie, absolu ou relatif. Le résultat y sera écrit.
  • Valeur de retour : voir write_to ci-dessus
• unwrap_buf(fl_in, write_to=None)
  • fl_in - file ou un objet file-like pour envelopper les données. Doit être ouvert en mode binaire et en fonctionnement seek ( 'rb' ).
  • write_to - la même chose que pour unwrap_path
  • Valeur de retour : la même chose que pour unwrap_path

Utilisation de la ligne de commande

Emballage / déballage entier du fichier dans un autre fichier. Exécutez ceci pour obtenir la liste des arguments:

python -m oc_sql_helpers.wrapper --help

normalisateur

La classe PLSQLNormalizer est une normalisation de code PL / SQL.

Le terme de normalisation

La normalisation signifie presque la même chose que le style de code , mais moins strictement. Cela signifie que le résultat de normalisation peut être inutilisable même si la source est correcte du point de vue PL / SQL .

La normalisation par défaut est:

• Toutes les fins de ligne sont remplacées en style Unix
• Toutes les déchets avant la première instruction CREATE non commissionnés sont supprimés.
• CREATE de l'instruction elle-même est commandée dans la première ligne jusqu'à AS token (ou IS ou WRAPPED ), y compris le nom d'objet, le type et le schéma. Les caractères d'espace supplémentaires et les commentaires sont remplacés par un seul espace.
• La première ligne (avec instruction CREATE ordonnée) est upprlasée , y compris le schéma et le nom de l'objet .
• Si le schéma ou le nom d'objet est donné en doubles-quotes " , alors ces doubles quotes seront supprimés si possible. Exemple: "schema"."name" sera SCHEMA.NAME après normalisation, tandis que "another.schema"."another.name" aura les citations de Doble: "ANOTHER.SCHEMA"."ANOTHER.NAME"
• La partie de repos du corps de définition d'objet ne sera pas modifiée

Un autre indicateur de normalisation :

• uppercase : tous les lexèmes de langue dans le corps d'objet seront upperés sauf les littéraux
• no-comments : Tous les commentaires à l'intérieur du corps, y compris les signes de commentaires eux-mêmes, seront remplacés par un seul espace.
• no-spaces : tous les caracles d'espace répétitifs (espace lui-même, newline, tabulation ...) seront remplacés par un seul espace général. Exemple: var := 'the value' ​​sera traduite par var := 'the value' . Notez qu'aucun remplacement n'est effectué à l'intérieur d'une 'the value' littérale. Ce drapeau peut ne pas être utilisé avec no-comments
• no-literals : Toutes les valeurs littérales de chaîne seront remplacées à celles vides. Les signes littéraux eux-mêmes ne sont pas modifiés.
• comments-only : Jetez l'ensemble du contenu du fichier mais les commentaires, y compris les signes de commentaires eux-mêmes. Chaque commentaire sera démarré avec une nouvelle ligne. Ce drapeau n'est pas compatible avec quiconque ci-dessus

Synopsis

PLSQLNormalizer() - pour instancier un objet pour cette classe

Méthodes

• normalize_path(path, flags=None, lines=None, write_to=None)
  • path - str objet avec un chemin absolu ou relatif pour le fichier pour normaliser.
  • flags - Flags de normalisation, list des entiers de l'énumération PLSQLNormalizationFlags , voir ci-dessous. None valeur ne signifie que faire par défaut ( CREATE la définition) la normalisation uniquement.
  • lines - int , limite les lignes de normalisation (comptées à partir de la source ). Par défaut : None , signifie normaliser la source entière
  • write_to - un de:
    • None - le résultat d'enveloppe sera renvoyé par cette méthode comme objet bytes
    • file - Le résultat sera écrit dans l'objet de type fichier spécifié ici. Doit être ouvert en mode binaire en lecture ( 'w+b' ) et en fonctionnement seek .
    • str - chemin vers le fichier de sortie, absolu ou relatif. Le résultat y sera écrit. Doit avoir une extension - il s'agit de featre de l'utilitaire d'Oracle wrap . Il ajoute le suffixe .plb seul si une extension a omis. Veuillez spécifier toujours l'extension
  • Valeur de retour : voir write_to ci-dessus
• normalize(fl, flags, lines=None write_to=None)
  • fl - Un de:
    • file ou objet file-like pour normaliser les données de. Doit être ouvert en mode binaire et en fonctionnement seek ( 'rb' ).
    • str - Données de chaîne pour normaliser
    • bytes - données "binaires" pour normaliser
  • flags - comme pour normalize_path
  • lines - la même chose que pour normalize_path
  • write_to - comme pour normalize_path
  • Valeur de retour : la même chose que pour normalize_path
• is_sql(fl) - Vérifiez que les données fournies sont prises en charge du code PL / SQL
  • fl - comme pour normalize
  • Retter Value - bool , code PL / SQL enveloppé ou non
• is_sql_path(path) - La même chose que is_sql mais l'argument est traité comme un chemin vers un fichier avec un code possible
• is_wrapped(fl) - Vérifiez que les données fournies sont prises en charge du code PL / SQL enveloppé
  • fl - comme pour normalize
  • Retter Value - bool , code PL / SQL pris en charge ou non
• is_wrapped_path(path) - La même chose que is_wrapped , mais l'argument est traité comme un chemin vers un fichier avec un code possible
• is_wrappable(fl) - Vérifiez que les données fournies sont prises en charge du code PL / SQL enveloppé
  • fl - comme pour normalize
  • Retter Value - bool , objet PL / SQL wrappable dans le code ou non
• is_wrappable_path(path) - la même chose que is_wrappable mais l'argument est traité comme un chemin vers un fichier avec un code possible

PLSQLNormalizationFlags - Énumération des drapeaux:

• uppercase
• no_comments
• no_spaces
• no_literals
• comments_only

Voir Description détaillée ci-dessus dans un autre chapitre des drapeaux de normalisation de la section du terme de normalisation .

Utilisation de la ligne de commande

Normaliser le fichier entier dans un autre fichier. Exécutez ceci pour obtenir la liste des arguments:

python -m oc_sql_helpers.normalizer --help