Rapidly Develop Magento-Driven Apps with Active Query Builder





Magento ODBC Driver

Magento ODBC Driver は、ODBC 接続をサポートするさまざまなアプリケーションからMagento のリアルタイムデータ連携を実現するパワフルなツールです。

RDB にアクセスするときと同感覚でMagento にアクセスし、標準ODBC Driver インターフェースを通じて読み出し、書き込み、更新が可能に。

Leverage the Active Query Builder SQL interface builder and the ease of .NET data access to create data-driven WinForms and ASP.NET apps.

Write standard .NET to expose Magento data through an SQL interface: Active Query Builder helps developers write SQL interfaces; the CData ODBC Driver for Magento enables standards-based access to Magento. This integration uses the Microsoft ADO.NET Provider for ODBC as a bridge between the ODBC Driver and the Active Query Builder objects to build a visual SQL composer.

Connect to Magento as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Magento はOAuth 1 認証標準を使用します。Magento REST API に接続するには、Magento システムにアプリを登録してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティの値を取得する必要があります。 OAuth 値を取得して接続するには、ヘルプドキュメントの「はじめに」を参照してください。

また、Magento システムへのURL を提供する必要があります。URL は、Magento REST API を顧客として使用しているか管理者として使用しているかによって異なります。

  • Customer: Magento を顧客として使用するには、事前にMagento のホームページで顧客アカウントを作成します。これを行うには、[アカウント]->[登録]をクリックします。それからURL 接続プロパティをMagento システムのエンドポイントに設定します。

  • Administrator: Magento を管理者として使用するには、代わりにCustomAdminPath を設定します。この値は、[Admin]メニューの[Advanced]設定で取得できます。[System]->[Configuration]->[Advanced]->[Admin]->[Admin Base URL]を選択することでアクセスできます。

    このページ上の[Use Custom Admin Path]設定がYES に設定されている場合、値は[Custom Admin Path]テキストボックス内にあります。それ以外の場合は、CustomAdminPath 接続プロパティをデフォルト値の"admin" に設定します。

Use SQL to Interact with Magento

Follow the steps below to create a WinForms visual query builder.

  1. In a new Windows Forms project, drag the QueryBuilder from the Toolbox onto the form.
  2. Add a reference to ActiveQueryBuilder.ODBCMetadataProvider.
  3. Add an OdbcConnection and set the connection string to the DSN that you created in the first section. OdbcConnection connection = new OdbcConnection(); connection.ConnectionString = "DSN=Magento"
  4. Initialize ODBCMetadataProvider and GeneralSyntaxProvider instances and set the Connection property of the ODBCMetadataProvider object to the OdbcConnection. GenericSyntaxProvider syntaxProvider = new GenericSyntaxProvider(); ODBCMetadataProvider metadataProvider = new ODBCMetadataProvider(); metadataProvider.Connection = connection;
  5. Set the corresponding MetadataProvider and SyntaxProvider properties of the QueryBuilder object. queryBuilder1.MetadataProvider = metadataProvider; queryBuilder1.SyntaxProvider = syntaxProvider;
  6. Call the InitiatelizeDatabaseSchemaTree method of the QueryBuilder class to retrieve Magento metadata and generate a tree view of Magento tables. queryBuilder1.InitializeDatabaseSchemaTree();
  7. After creating the QueryBuilder, connect it to a TextBox or, as we use, the ActiveQueryBuilder SQLTextEditor: Drag and drop an SQLTextEditor onto the designer.

  8. Add the following code to the Validating event for the SQLTextEditor: private void sqlTextEditor1_Validating(object sender, CancelEventArgs e) { try { // Update the query builder with manually edited query text: queryBuilder1.SQL = sqlTextEditor1.Text; } catch (SQLParsingException ex) { e.Cancel = true; // Set caret to error position sqlTextEditor1.SelectionStart = ex.ErrorPos.pos; // Report error MessageBox.Show(ex.Message, "Parsing error"); } }
  9. Add the following to the SQLUpdated event: private void queryBuilder1_SQLUpdated(object sender, EventArgs e) { sqlTextEditor1.Text = queryBuilder1.FormattedSQL; }
  10. You can now build queries visually: Double-click a table in the Columns Pane Area and an entity/relationship diagram is displayed in the Query Building Area. Columns that you select in the diagram are added to the query.