🕹️ 💆🏾 👨🏻‍💼 Node.jsのMySQLドライバーの屋外施設 🙎🏽 🔃 🤘🏿

Node.jsで書いてMySQLを使用している人なら誰でも、3年前に親友のFelixGeisendörferが英雄的で無私の偉業を成し遂げたことを知っています。彼だけがMySQLに接続するための非常に高品質のドライバーを開発し、JavaScript でこのDBMSのバイナリプロトコルをネイティブに実装しました 。その後、他の尊敬される同志がプロジェクトに参加し、接続プール、クラスター、トランザクションのサポート、一時的な接続の喪失を伴う復元が実装されました。現在、このドライバーは、オープンなnpmおよびgithubリポジトリにあるものから最も開発され、よく開発され、積極的にサポートされています。低レベルの実装が十分に開発されているため、このドライバーがアプリケーション開発者に提供するすべての機能が単一のクエリメソッドに集約されることは驚くべきことです。個人的には、これだけでは十分ではありません。祖父は、スカラー値、行と列を配列に返す便利さ、データベース構造のイントロスペクションに慣れました。それで、これらの開発を、私の愛するKhabravchaneと共有できることを嬉しく思いますが、すべての設備が路上にあることを警告します。もちろん、ドライバーとの緊密な統合の変形がありますが、 FelixGeはドライバーを排他的に低レベルにしたいので、不純物を介してドライバーに追加する外部ライブラリのオプションに決めました。不純物の形で、アメニティもImpressプラットフォームに組み込まれ、ドライバー用のパッチとして公開されました。以下の機能とユースケースについて。

データ取得のアメニティ

さらに、「戻り値」という言葉の下では、関数を呼び出した結果ではなく、2番目のパラメーターコールバックを意味します。

1つのレコードのフェッチ：接続。 queryRow （sql、values、callback）は、フィールド名がキーになるハッシュ（連想配列）を返します（クエリで配列内の配列を取得する代わりに）。

例

connection.queryRow('SELECT * FROM Language where LanguageId=?', [3], function(err, row) { console.dir({queryRow:row}); /* Example: queryRow: { LanguageId: 3, LanguageName: 'Russian', LanguageSign: 'ru', LanguageISO: 'ru', Caption: '' } */ });

スカラー （つまり、単一の値）の取得：接続。 queryValue （sql、values、callback）は、単一の値を持つ配列の配列を取得する代わりに、単一の値を返します。 1つのレコードから1つのフィールドをフェッチするときに便利です。たとえば、LIMIT 1を示す名前によるID、または関数count（*）、max（field）などです。

例

 connection.queryValue('SELECT LanguageName FROM Language where LanguageId=?', [8], function(err, name) { console.dir({queryValue:name}); /* Example: queryValue: 'Italiano' */ });

単一列フェッチ ：接続。 queryCol （sql、values、callback）は、クエリの結果から各レコードの1つのフィールドの値で満たされた配列を返します。つまり、水平レコードqueryRowの選択ではなく、垂直列の選択です。
UPD： gelasは、queryArrayの名前をqueryRowに似たqueryColに変更するように私を説得しました。

例

 connection.queryCol('SELECT LanguageSign FROM Language', [], function(err, result) { console.dir({queryCal:result}); /* Example: queryArray: [ 'de', 'en', 'es', 'fr', 'it', 'pl', 'ru', 'ua' ] */ });

ハッシュフェッチ ：接続。 queryHash （sql、values、callback）は、2レベルのネストのハッシュ（連想配列）を返します。第1レベルのキーはクエリ結果の最初のフィールドの値であり、第2レベルのキーはクエリ結果のすべてのフィールド（最初を含む）です。

例

 connection.queryHash( 'SELECT LanguageSign, LanguageId, LanguageName, Caption, LanguageISO FROM Language', [], function(err, result) { console.dir({queryHash:result}); /* Example: queryHash: { en: { LanguageSign: 'en', LanguageId: 2, LanguageName: 'English', Caption: '', LanguageISO: 'en' }, ru: { LanguageSign: 'ru', LanguageId: 3, LanguageName: 'Russian', Caption: '', LanguageISO: 'ru' }, de: { LanguageSign: 'de', LanguageId: 7, LanguageName: 'Deutsch', Caption: '', LanguageISO: 'de' }, it: { LanguageSign: 'it', LanguageId: 8, LanguageName: 'Italiano', Caption: '', LanguageISO: 'it' } } */ });

キー/値のペアの選択：接続。 queryKeyValue （sql、values、callback）はハッシュ（連想配列）を返します。ここで、キーはクエリ結果からクエリへの最初のフィールドです。

例

 connection.queryKeyValue( 'SELECT LanguageISO, LanguageName FROM Language', [], function(err, keyValue) { console.dir({queryKeyValue:keyValue}); /* Example: keyValue: { en: 'English', ru: 'Russian', uk: 'Ukrainian', es: 'Espanol', fr: 'Francais', de: 'Deutsch', it: 'Italiano', pl: 'Poliski' } */ });

イントロスペクションの便利さ

つまり、分析のためのデータベースのメタデータ、構造、およびパラメーターの取得、およびこのデータベースを操作するためのロジックまたはインターフェースの自動構築の便利さ。

主キーの取得：接続。 primary （テーブル、コールバック）は、プライマリキーに関するメタデータを含むハッシュ（連想配列）を返します。例のメタデータセットを参照してください。

例

 connection.primary('Language', function(err, primary) { console.dir({primary:primary}); /* Example: primary: { Table: 'language', Non_unique: 0, Key_name: 'PRIMARY', Seq_in_index: 1, Column_name: 'LanguageId', Collation: 'A', Cardinality: 9, Sub_part: null, Packed: null, Null: '', Index_type: 'BTREE', Comment: '', Index_comment: '' } */ });

外部キーの取得：接続。 foreign （テーブル、コールバック）は、ダブルネストでハッシュ（連想配列）を返します。最初のレベルは外部キーの名前で、2番目はこのキーを記述するメタデータです。一連のフィールドについては、例を参照してください。

例

 connection.foreign('TemplateCaption', function(err, foreign) { console.dir({foreign:foreign}); /* Example: foreign: { fkTemplateCaptionLanguage: { CONSTRAINT_NAME: 'fkTemplateCaptionLanguage', COLUMN_NAME: 'LanguageId', ORDINAL_POSITION: 1, POSITION_IN_UNIQUE_CONSTRAINT: 1, REFERENCED_TABLE_NAME: 'language', REFERENCED_COLUMN_NAME: 'LanguageId' }, fkTemplateCaptionTemplate: { CONSTRAINT_NAME: 'fkTemplateCaptionTemplate', COLUMN_NAME: 'TemplateId', ORDINAL_POSITION: 1, POSITION_IN_UNIQUE_CONSTRAINT: 1, REFERENCED_TABLE_NAME: 'template', REFERENCED_COLUMN_NAME: 'TemplateId' } */ });

整合性制約の取得：接続。制約（テーブル、コールバック）は、二重ネストのハッシュ（連想配列）を返します。最初のレベルは整合性制約の名前で、2番目は各制約を記述するメタデータです。一連のフィールドの例を参照してください。

例

 connection.constraints('TemplateCaption', function(err, constraints) { console.dir({constraints:constraints}); /* Example: constraints: { fkTemplateCaptionLanguage: { CONSTRAINT_NAME: 'fkTemplateCaptionLanguage', UNIQUE_CONSTRAINT_NAME: 'PRIMARY', REFERENCED_TABLE_NAME: 'Language', MATCH_OPTION: 'NONE', UPDATE_RULE: 'RESTRICT', DELETE_RULE: 'CASCADE' }, fkTemplateCaptionTemplate: { CONSTRAINT_NAME: 'fkTemplateCaptionTemplate', UNIQUE_CONSTRAINT_NAME: 'PRIMARY', REFERENCED_TABLE_NAME: 'Template', MATCH_OPTION: 'NONE', UPDATE_RULE: 'RESTRICT', DELETE_RULE: 'CASCADE' } } */ });

テーブルフィールドに関するメタデータの取得：接続。 fields （テーブル、コールバック）は、名前、タイプ、すべての修飾子とフラグ、コメントを含む各フィールドのメタデータを持つ配列を返します（詳細については例を参照してください）。

例

 connection.fields('Language', function(err, fields) { console.dir({fields:fields}); /* Example: fields: { LanguageId: { Field: 'LanguageId', Type: 'int(10) unsigned', Collation: null, Null: 'NO', Key: 'PRI', Default: null, Extra: 'auto_increment', Privileges: 'select,insert,update,references', Comment: 'Id(EN),(RU)' }, LanguageName: { Field: 'LanguageName', Type: 'varchar(32)', Collation: 'utf8_general_ci', Null: 'NO', Key: 'UNI', Default: null, Extra: '', Privileges: 'select,insert,update,references', Comment: 'Name(EN),(RU)' }, ... } */ });

この接続で使用可能なデータベースのリストの取得：connection。 データベース （コールバック）は、データベース名（または「スキーマ」と呼ばれることもある）の配列を返します。

例

 connection.databases(function(err, databases) { console.dir({databases:databases}); /* Example: databases: [ 'information_schema', 'mezha', 'mysql', 'performance_schema', 'test' ] */ });

この接続：connectionに対して現在選択されているデータベースのテーブルのリストを取得しています。 tables （コールバック）は、二重ネストのハッシュ（連想配列）を返します。最初のレベルではキーはテーブルの名前で、2番目では各テーブルのメタデータです。

例

 connection.tables(function(err, tables) { console.dir({tables:tables}); /* Example: tables: { Language: { TABLE_NAME: 'Language', TABLE_TYPE: 'BASE TABLE', ENGINE: 'InnoDB', VERSION: 10, ROW_FORMAT: 'Compact', TABLE_ROWS: 9, AVG_ROW_LENGTH: 1820, DATA_LENGTH: 16384, MAX_DATA_LENGTH: 0, INDEX_LENGTH: 49152, DATA_FREE: 8388608, AUTO_INCREMENT: 10, CREATE_TIME: Mon Jul 15 2013 03:06:08 GMT+0300 ( ()), UPDATE_TIME: null, CHECK_TIME: null, TABLE_COLLATION: 'utf8_general_ci', CHECKSUM: null, CREATE_OPTIONS: '', TABLE_COMMENT: '_Language:Languages(EN),(RU)' }, ... } */ });

UPD：指定されたデータベースのテーブルのリストを取得します：接続。 databaseTables （データベース、コールバック）は、二重ネストのハッシュ（連想配列）を返します。最初のレベルではキーはテーブルの名前で、2番目は各テーブルのメタデータです。

例

 connection.databaseTables("databaseName", function(err, tables) { console.dir({databaseTables:tables}); /* Example: tables: { Language: { TABLE_NAME: 'Language', TABLE_TYPE: 'BASE TABLE', ENGINE: 'InnoDB', VERSION: 10, ROW_FORMAT: 'Compact', TABLE_ROWS: 9, AVG_ROW_LENGTH: 1820, DATA_LENGTH: 16384, MAX_DATA_LENGTH: 0, INDEX_LENGTH: 49152, DATA_FREE: 8388608, AUTO_INCREMENT: 10, CREATE_TIME: Mon Jul 15 2013 03:06:08 GMT+0300 ( ()), UPDATE_TIME: null, CHECK_TIME: null, TABLE_COLLATION: 'utf8_general_ci', CHECKSUM: null, CREATE_OPTIONS: '', TABLE_COMMENT: '_Language:Languages(EN),(RU)' }, ... } */ });

指定されたテーブルの接続のメタデータを取得しています 。 tableInfo （テーブル、コールバック）は、メタデータを含むハッシュ（連想配列）を返します（詳細については例を参照してください）。

例

 connection.tableInfo('Language', function(err, info) { console.dir({tableInfo:info}); /* Example: tableInfo: { Name: 'language', Engine: 'InnoDB', Version: 10, Row_format: 'Compact', Rows: 9, Avg_row_length: 1820, Data_length: 16384, Max_data_length: 0, Index_length: 49152, Data_free: 9437184, Auto_increment: 10, Create_time: Mon Jul 15 2013 03:06:08 GMT+0300 ( ()), Update_time: null, Check_time: null, Collation: 'utf8_general_ci', Checksum: null, Create_options: '', Comment: '' } */ });

この表のすべてのキーに関するメタデータの取得：接続。 インデックス （テーブル、コールバック）はハッシュ（連想配列）を返しますか？その第1レベルのキーはデータベースキーの名前（）であり、第2レベルのキーは各キーに関するメタデータです（メタデータの詳細なリストの例を参照）。

例

 connection.indexes('Language', function(err, info) { console.dir({tableInfo:info}); /* Example: indexes: { PRIMARY: { Table: 'language', Non_unique: 0, Key_name: 'PRIMARY', Seq_in_index: 1, Column_name: 'LanguageId', Collation: 'A', Cardinality: 9, Sub_part: null, Packed: null, Null: '', Index_type: 'BTREE', Comment: '', Index_comment: '' }, akLanguage: { Table: 'language', Non_unique: 0, Key_name: 'akLanguage', Seq_in_index: 1, Column_name: 'LanguageName', Collation: 'A', Cardinality: 9, Sub_part: null, Packed: null, Null: '', Index_type: 'BTREE', Comment: '', Index_comment: '' } } */ });

MySQL サーバーでのプロセスの取得：接続。 processes （コールバック）は、各プロセスにパラメーターが指定されているハッシュの配列を返します。

例

 connection.processes(function(err, processes) { console.dir({processes:processes}); /* Example: processes: [ { ID: 62, USER: 'mezha', HOST: 'localhost:14188', DB: 'mezha', COMMAND: 'Query', TIME: 0, STATE: 'executing', INFO: 'SELECT * FROM information_schema.PROCESSLIST' }, { ID: 33, USER: 'root', HOST: 'localhost:39589', DB: null, COMMAND: 'Sleep', TIME: 1, STATE: '', INFO: null } ] */ });

グローバルな MySQL 変数の取得：接続。 globalVariables （コールバック）

例

 connection.globalVariables(function(err, globalVariables) { console.dir({globalVariables:globalVariables}); /* Example: globalVariables: { MAX_PREPARED_STMT_COUNT: '16382', MAX_JOIN_SIZE: '18446744073709551615', HAVE_CRYPT: 'NO', PERFORMANCE_SCHEMA_EVENTS_WAITS_HISTORY_LONG_SIZE: '10000', INNODB_VERSION: '5.5.32', FLUSH_TIME: '1800', MAX_ERROR_COUNT: '64', ... } */ });

MySQL：接続のグローバルステータスの取得。 globalStatus （コールバック）

例

 connection.globalStatus(function(err, globalStatus) { console.dir({globalStatus:globalStatus}); /* Example: globalStatus: { ABORTED_CLIENTS: '54', ABORTED_CONNECTS: '2', BINLOG_CACHE_DISK_USE: '0', BINLOG_CACHE_USE: '0', BINLOG_STMT_CACHE_DISK_USE: '0', BINLOG_STMT_CACHE_USE: '0', BYTES_RECEIVED: '654871', BYTES_SENT: '212454927', COM_ADMIN_COMMANDS: '594', ... } */ });

MySQL ユーザーのリスト：接続。 ユーザー （コールバック）

例

 connection.users(function(err, users) { console.dir({users:users}); /* Example: users: [ { Host: 'localhost', User: 'root', Password: '*90E462C37378CED12064BB3388827D2BA3A9B689', Select_priv: 'Y', Insert_priv: 'Y', Update_priv: 'Y', Delete_priv: 'Y', Create_priv: 'Y', Drop_priv: 'Y', Reload_priv: 'Y', Shutdown_priv: 'Y', Process_priv: 'Y', File_priv: 'Y', Grant_priv: 'Y', References_priv: 'Y', Index_priv: 'Y', Alter_priv: 'Y', Show_db_priv: 'Y', Super_priv: 'Y', Create_tmp_table_priv: 'Y', Lock_tables_priv: 'Y', Execute_priv: 'Y', Repl_slave_priv: 'Y', Repl_client_priv: 'Y', Create_view_priv: 'Y', Show_view_priv: 'Y', Create_routine_priv: 'Y', Alter_routine_priv: 'Y', Create_user_priv: 'Y', Event_priv: 'Y', Trigger_priv: 'Y', Create_tablespace_priv: 'Y', ssl_type: '', ssl_cipher: <Buffer >, x509_issuer: <Buffer >, x509_subject: <Buffer >, max_questions: 0, max_updates: 0, max_connections: 0, max_user_connections: 0, plugin: '', authentication_string: '' }, ... ] */ });

クエリ生成の便利さ

SQLを生成したり、WHERE式を完全に分離したり、別々にしたりすることができる、非常に優れた便利さ私自身はそのような砂糖の支持者ではありませんが、事前に知られていないクエリの生成を自動化することが必要な場合があります。

条件生成 ：接続。 ここで （条件）は、他の機能と同様に、非同期ではなく同期的に機能します。コールバックを使用しません。 JSONスタイルで記述された条件の組み込みWHERE SQL式を返します。理解するには、例を必ず確認する必要があります。

例

 var where = connection.where({ id: 5, year: ">2010", price: "100..200", level: "<=3", sn: "*str?", label: "str", code: "(1,2,4,10,11)" }); console.dir(where); // Output: "id = 5 AND year > '2010' AND (price BETWEEN '100' AND '200') AND // level <= '3' AND sn LIKE '%str_' AND label = 'str' AND code IN (1,2,4,10,11)"

条件付きの選択：接続。選択（テーブル、whereFilter、コールバック）

例

 connection.select('Language', '*', { LanguageId: "1..3" }, function(err, results) { console.dir({select:results}); });

レコードの挿入：接続。挿入（テーブル、行、コールバック）

例

 connection.insert('Language', { LanguageName: 'Tatar', LanguageSign:'TT', LanguageISO:'TT', Caption:'Tatar' }, function(err, recordId) { console.dir({insert:recordId}); });

レコードの編集：接続。更新（テーブル、行、コールバック）

例

 connection.update('Language', { LanguageId: 25, LanguageName:'Tatarca', LanguageSign:'TT', LanguageISO:'TT', Caption:'Tatarca' }, function(err, affectedRows) { console.dir({update:affectedRows}); });

そのようなエントリがない場合は挿入するか、すでに存在する場合は変更します：connection。 アップサート （テーブル、行、コールバック）

例

 connection.upsert('Language', { LanguageId: 25, LanguageName:'Tatarca', LanguageSign:'TT', LanguageISO:'TT', Caption:'Tatarca' }, function(err, affectedRows) { console.dir({upsert:affectedRows}); });

特定のフィルターまたはフィルターなしでテーブル内のレコード数を取得：connection.count（table、whereFilter、callback）

例

 connection.count('Language', { LanguageId: ">3" }, function(err, count) { console.dir({count:count}); /* Example: count: 9 */ });

1つまたは複数のレコード：接続を削除します。削除（テーブル、whereFilter、コールバック）

例

 connection.delete('Language', { LanguageSign:'TT' }, function(err, affectedRows) { console.dir({delete:affectedRows}); });

ユースケース

UPD： 独立したモジュールを使用することをお勧めします。ドライバーよりも抽象化のレベルが高く、ORMライブラリほど高くありません。この面倒なことはしたくありません。また、不純物（必要な場合のみ）の関数グループを介して接続に機能を追加する機会を残したいと思います。
これは次のように行われます。

 // Library dependencies var mysql = require('mysql'), mysqlUtilities = require('utilities'); var connection = mysql.createConnection({ host: 'localhost', user: 'userName', password: 'secret', database: 'databaseName' }); connection.connect(); // Mix-in for Data Access Methods and SQL Autogenerating Methods mysqlUtilities.upgrade(connection); // Mix-in for Introspection Methods mysqlUtilities.introspection(connection); // Do something using utilities connection.queryRow( 'SELECT * FROM _Language where LanguageId=?', [3], function(err, row) { console.dir({queryRow:row}); } ); // Release connection connection.end();

上記のすべての機能を備えたnode-mysqlドライバー用のパッチもあります： https : //github.com/felixge/node-mysql

3番目の使用例は、このライブラリが組み込まれているNode.js用のImpressアプリケーションサーバーです。 MySQLへのすべての接続にはすぐにImpressのサンプリング関数の2つのグループがあり、接続が開かれると自動的に混合されます。また、MySQLのプラグインのセットが次のようになるように、対応するプラグインのコメントを外す必要がある構成を介してイントロスペクションのみを追加できます：

  plugins: { require: [ "db", "db.mysql", "db.mysql.introspection", ... ] },...

次に、プラグインは各接続と自動的に混合します。if（db.mysql.introspection）db.mysql.introspection（connection）;
Impressプラグインのソースコードは次のとおりです。

参照資料

UPD：執筆時点では、2つの実装オプション（ドライバーのパッチとImpressのモジュール）がありましたが、調査では、時間をかけてこのライブラリを個別のモジュールとして設計することが理にかなっていることが納得できました。これは同じ日の夕方までに行われました。ただし、これらのアメニティの有用性の程度を判断するために調査を終了することはありません。

主な使用例は次のとおりです。
Github： https : //github.com/tshemsedinov/node-mysql-utilities
nmpリポジトリー内： https ://npmjs.org/package/mysql-utilities

Node.jsのMySQLドライバーの屋外施設

データ取得のアメニティ

イントロスペクションの便利さ

クエリ生成の便利さ

ユースケース

参照資料

More articles: