| List: | Commits | « Previous MessageNext Message » | |
| From: | mcbrown | Date: | December 12 2006 4:16pm |
| Subject: | svn commit - mysqldoc@docsrva: r4219 - in trunk: refman-5.0 refman-5.0/images refman-5.1 refman-5.1/images | ||
| View as plain text | |||
Author: mcbrown Date: 2006-12-12 16:16:27 +0100 (Tue, 12 Dec 2006) New Revision: 4219 Log: Adding the VisualStudio plugin manual content Added: trunk/refman-5.0/connector-vstudioplugin.xml trunk/refman-5.0/images/mysql-vstudioplugin-1.png trunk/refman-5.0/images/mysql-vstudioplugin-2.png trunk/refman-5.0/images/mysql-vstudioplugin-3.png trunk/refman-5.0/images/mysql-vstudioplugin-4.png trunk/refman-5.1/connector-vstudioplugin.xml trunk/refman-5.1/images/mysql-vstudioplugin-1.png trunk/refman-5.1/images/mysql-vstudioplugin-2.png trunk/refman-5.1/images/mysql-vstudioplugin-3.png trunk/refman-5.1/images/mysql-vstudioplugin-4.png Property changes on: trunk/refman-5.0/images/mysql-vstudioplugin-1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Property changes on: trunk/refman-5.0/images/mysql-vstudioplugin-2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Property changes on: trunk/refman-5.0/images/mysql-vstudioplugin-3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Property changes on: trunk/refman-5.0/images/mysql-vstudioplugin-4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Property changes on: trunk/refman-5.1/images/mysql-vstudioplugin-1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Property changes on: trunk/refman-5.1/images/mysql-vstudioplugin-2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Property changes on: trunk/refman-5.1/images/mysql-vstudioplugin-3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Property changes on: trunk/refman-5.1/images/mysql-vstudioplugin-4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/refman-5.0/connector-vstudioplugin.xml =================================================================== --- trunk/refman-5.0/connector-vstudioplugin.xml (rev 0) +++ trunk/refman-5.0/connector-vstudioplugin.xml 2006-12-12 15:16:27 UTC (rev 4219) Changed blocks: 1, Lines Added: 1320, Lines Deleted: 0; 40296 bytes @@ -0,0 +1,1320 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent"> + %fixedchars.entities; +]> +<section id="connector-vstudio"> + + <title>MySQL Visual Studio Plugin</title> + + <para> + The MySQL Visual Studio Plugin is a DDEX provider; a plug-in for + Visual Studio 2005 that allows developers to maintain database + structures, and supports built-in data-driven application + development tools. + </para> + + <para> + The current version of the MySQL Visual Studio Pluginincludes only + database maintenance tools. Data-driven application development + tools are not supported. + </para> + + <para> + The MySQL DDEX Provider operates as a standard extension to the + Visual Studio Data Designer functionality available through the + Server Explorer menu of Visual Studio 2005, and enables developers + to create database objects and data within a MySQL database. + </para> + + <para> + The MySQL DDEX Provider is designed to work with MySQL version 5.0, + but is also compatible with MySQL 4.1.1 and provides limited + compatibility with MySQL 5.1. + </para> + + <section id="connector-vstudio-install"> + + <title>Installing the MySQL Visual Studio Plugin</title> + + <para> + The MySQL DDEX Provider requires Visual Studio 2005 Professional + Edition to be installed, and therefore it has the same hardware + and system requirements. + </para> + + <para> + Here is the list of components that should already be installed + before starting the installation of the MySQL DDEX Provider: + </para> + + <itemizedlist> + + <listitem> + <para> + Visual Studio 2005 Standard, Professional or Team Developer + Edition. + </para> + </listitem> + + <listitem> + <para> + MySQL Server 4.1.1 or later (either installed on the same + machine, or a separate server). + </para> + </listitem> + + <listitem> + <para> + MySQL Connector.NET 5.0. + </para> + </listitem> + + </itemizedlist> + + <para> + The user used to connect to the MySQL server must have the + following privileges to use the functionality provided by the + MySQL DDEX Provider: + </para> + + <itemizedlist> + + <listitem> + <para> + The <literal>SELECT</literal> privilege for the + <literal>INFORMATION_SCHEMA</literal> database. + </para> + </listitem> + + <listitem> + <para> + The <literal>EXECUTE</literal> privilege for the <literal>SHOW + CREATE TABLE</literal> statement. + </para> + </listitem> + + <listitem> + <para> + The <literal>SELECT</literal> privilege for the + <literal>mysql.proc</literal> table (required for operations + with stored procedures and functions). + </para> + </listitem> + + <listitem> + <para> + The <literal>SELECT</literal> privilege for the + <literal>mysql.func</literal> table (required for operations + with User Defined Functions (UDF)). + </para> + </listitem> + + <listitem> + <para> + The <literal>EXECUTE</literal> privilege for the <literal>SHOW + ENGINE STATUS</literal> statement (required for retrieving + extended error information). + </para> + </listitem> + + <listitem> + <para> + Appropriate privileges for performed operations (e.g. the + <literal>SELECT</literal> privilege is required to browse data + from a table etc.). + </para> + </listitem> + + </itemizedlist> + + <para> + The MySQL DDEX Provider is delivered as a MSI package that can be + used to install, uninstall or reinstall the Provider. If you are + not using Windows XP or Windows Server 2003 you upgrade the + Windows Installer system to the latest version (see + <ulink url="http://support.microsoft.com/default.aspx?scid=kb;EN-US;292539">http://support.microsoft.com/default.aspx?scid=kb;EN-US;292539</ulink> + for details). + </para> + + <para> + The MSI-package is named <filename>MySQL-DDEX.msi</filename>. To + install the MySQL DDEX Provider, right click on the MSI file and + select <guimenu>Install</guimenu>. The installation process is as + follow: + </para> + + <orderedlist> + + <listitem> + <para> + The standard Welcome dialog is opened. Click Next to continue + installation. + </para> + </listitem> + + <listitem> + <para> + The License agreement (GNU GPL) window is opened. Accept the + agreement and click <guibutton>Next</guibutton> to continue. + </para> + </listitem> + + <listitem> + <para> + The destination folder choice dialog is opened. Here you can + point out the folder where the MySQL DDEX Provider will be + installed. The default destination folder is + <filename>%ProgramFilesDir%\MySQL\MySQL DDEX Data + Provider</filename>, where + <filename>%ProgramFilesDir%</filename> is the Program Files + folder of the installation machine. After choosing the + destination folder, click <guibutton>Next</guibutton> to + continue. + </para> + </listitem> + + <listitem> + <para> + The installer will ask to confirm that installation. Click + Install to start installation process. + </para> + </listitem> + + <listitem> + <para> + The installation will now take place. At the end of this step + the Visual Studio command table is rebuilt (this process may + take several minutes). + </para> + </listitem> + + <listitem> + <para> + Once installation is complete, click + <guibutton>Finish</guibutton> to end the installation process. + </para> + </listitem> + + </orderedlist> + + <para> + To uninstall the MySQL DDEX Provider, you can use either + Add/Remove Programs component of the Control Panel or the same + MSI-package. Choose the <guilabel>Remove</guilabel> option, and + the Provider will be uninstalled automatically. + </para> + + <para> + To repair the Provider, right click the MSI-package and choose the + <guimenu>Repair</guimenu> option. The MySQL DDEX Provider will be + repaired automatically. + </para> + + <para> + The installation package includes the following files: + </para> + + <itemizedlist> + + <listitem> + <para> + <filename>MySQL.VisualStudio.dll</filename> — the MySQL + DDEX Provider assembly. + </para> + </listitem> + + <listitem> + <para> + <filename>MySQL.Data.dll</filename> — the assembly + containing the MySQL Connector .NET which is used by the + Provider. + </para> + </listitem> + + <listitem> + <para> + <filename>MySql.VisualStudio.dll.config</filename> — the + configuration file for the MySQL DDEX Provider. This file + contains default values for the provider GUI layout. + </para> + + <note> + <para> + Do not remove this file before the first use of the + Provider. + </para> + </note> + </listitem> + + <listitem> + <para> + <filename>Register.reg</filename> — the file with + registry entries that can be used to register the MySQL DDEX + Provider in the case of the manual installation. + </para> + </listitem> + + <listitem> + <para> + <filename>Install.js</filename> — the script used to + register the Connector .NET as an ADO.NET data provider in the + machine.config file. + </para> + </listitem> + + <listitem> + <para> + <filename>Release notes.doc</filename> — the document + with release notes. + </para> + </listitem> + + </itemizedlist> + + <para> + To install the Provider manually, copy all files of the + installation package in a desired folder, then set the full path + to the Provider assembly as a value of the CodeBase entry. For + example: + </para> + +<programlisting>[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\8.0\Packages\{79A115C9-B133-4891-9E7B-242509DAD272}]@="MySql.Data.VisualStudio.MySqlDataProviderPackage" +"InprocServer32"="C:\\WINNT\\system32\\mscoree.dll" +"Class"="MySql.Data.VisualStudio.MySqlDataProviderPackage" +"CodeBase"="C:\\MySqlDdexProvider\\MySql.VisualStudio.dll" +</programlisting> + + <para> + Then import information from the Register.reg file to the registry + by clicking of the file. At the confirmation dialog choose Yes. + Next you must run the command devenv.exe /setup within a Command + Prompt to rebuild the Visual Studio command table. + </para> + + </section> + + <section id="connector-vstudio-creating"> + + <title>Creating a connection to the MySQL server</title> + + <para> + Once the MySQL DDEX Provider is installed, you can use it to + create, modify and delete connections to MySQL databases. To + create a connection with a MySQL database, perform the following + steps: + </para> + + <orderedlist> + + <listitem> + <para> + Start Visual Studio 2005 and open Server Explorer window by + choosing the <guimenu>Server Explorer</guimenu> option from + the <guimenu>View</guimenu> menu. + </para> + </listitem> + + <listitem> + <para> + Right click on the <guilabel>Data Connections</guilabel> node + and choose the <guibutton>Add Connection</guibutton> button. + </para> + </listitem> + + <listitem> + <para> + The Add Connection dialog is opened. Press the + <guibutton>Change</guibutton> button to choose MySQL Database + as a data source. + </para> + </listitem> + + <listitem> + <para> + Change Data Source dialog is opened. Choose MySQL Database in + the list of data sources (or the <literal>other</literal> + option, if MySQL Database is absent), and then choose + <guilabel>.NET Framework Data Provider for MySQL</guilabel> in + the combo box of data providers. + </para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/mysql-vstudioplugin-1.png" format="PNG"/> + </imageobject> + <textobject> + <phrase lang="en">Choosing a data source</phrase> + </textobject> + </mediaobject> + + <para> + Press <guibutton>OK</guibutton> to confirm your choice. + </para> + </listitem> + + <listitem> + <para> + Enter the connection settings: the server host name (for + example, localhost if the MySQL server is installed on the + local machine), the user name, the password, and the default + database schema. Note that you must specify the default schema + name to open the connection. + </para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/mysql-vstudioplugin-1.png" format="PNG"/> + </imageobject> + <textobject> + <phrase lang="en">Setting connection properties</phrase> + </textobject> + </mediaobject> + </listitem> + + <listitem> + <para> + You can also set the port to connect with the MySQL server by + pressing the <guibutton>Advanced</guibutton> button. To test a + connection with the MySQL server, ser the server host name, + the user name, and the password, and press the <guibutton>Test + Connection</guibutton> button. If the test fails, check the + connection values that you have supplied are correct and that + the corresponding user and privileges have been configured on + the MySQL server. + </para> + </listitem> + + <listitem> + <para> + After you set all settings and test the connection, press + <guibutton>OK</guibutton>. The newly created connection is + displayed in Server Explorer. Now you can work with the MySQL + server through standard Server Explorer interface. + </para> + </listitem> + + </orderedlist> + + <para> + After a connection is successfully established, all the connection + settings are saved. When you next open Visual Studio, the + connection to the MySQL server will appear within Server Explorer + so that you can re-establish a connection to the MySQL server. + </para> + + <para> + To modify and delete a connection, use the <guimenu>Server + Explorer</guimenu> context menu for the corresponding node. You + can modify any of the settings just by overwriting the existing + values with new ones. Note that a connection should be modified or + deleted only if no active editor for it's objects is opened. + Otherwise your data could be lost. + </para> + + </section> + + <section id="connector-vstudio-using"> + + <title>Using the MySQL DDEX Provider</title> + + <para> + To work with a MySQL server using the MySQL DDEX Provider, open + the Visual Studio 2005, open the <guilabel>Server + Explorer</guilabel>, and select the required connection. The + working area of the MySQL DDEX Provider consists of three parts. + </para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/mysql-vstudioplugin-3.png" format="PNG"/> + </imageobject> + <textobject> + <phrase lang="en">DDEX enviroment</phrase> + </textobject> + </mediaobject> + + <itemizedlist> + + <listitem> + <para> + Database objects (tables, views, stored routines, triggers, + and user defined functions) are displayed in the Server + Explorer tree. Here you can choose an object and edit its + properties and definition. + </para> + </listitem> + + <listitem> + <para> + Properties of a selected database object are displayed in the + <guilabel>Properties</guilabel> panel. Certain properties can + be edited directly within this window. + </para> + </listitem> + + <listitem> + <para> + The editor panel provides direct access to the SQL statement + and definition of specific objects. Fore example, the SQL + statements within a stored procedure definition are shown and + edited within this panel. + </para> + </listitem> + + </itemizedlist> + + <section id="connector-vstudio-using-tables"> + + <title>Editing Tables</title> + + <para> + The Table Editor can be accessed through a mouse action on + table-type node of Server Explorer. To create a new table, right + click on the <guilabel>Tables</guilabel> node (under the + connection node) and choose the <guimenu>Create Table</guimenu> + command from a context menu. To modify an existing table, double + click on a node of the table you wish to modify, or right click + on this node and choose the <guimenu>Alter Table</guimenu> + command from a context menu. Either of the commands opens the + Table Editor. + </para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/mysql-vstudioplugin-4.png" format="PNG"/> + </imageobject> + <textobject> + <phrase lang="en">Editing a table</phrase> + </textobject> + </mediaobject> + + <para> + The MySQL DDEX Provider Table Editor is implemented in a similar + fashion to the standard Query Browser Table Editor, but with + minor differences. + </para> + + <para> + The Table Editor consists of the following parts: + </para> + + <itemizedlist> + + <listitem> + <para> + Columns Editor — for column creation, modification and + deletion. + </para> + </listitem> + + <listitem> + <para> + Indexes tab — for table/column index management. + </para> + </listitem> + + <listitem> + <para> + Foreign Keys tab — for configuration of foreign keys. + </para> + </listitem> + + <listitem> + <para> + Column Details tab — used to set advanced column + options. + </para> + </listitem> + + <listitem> + <para> + Properties window — used to set table properties. + </para> + </listitem> + + </itemizedlist> + + <para> + To save changes you have made in the Table Editor, use either + Save or Save All buttons of the Visual Studio main toolbar, or + just press <keycap>Ctrl+S</keycap>. Before changes are saved, a + confirmation dialog will be displayed to confirm that you want + to update the corresponding object within the MySQL database. + </para> + + <section id="connector-vstudio-using-tables-columns"> + + <title>Column Editor</title> + + <para> + You can use the Column Editor to set or change the name, data + type, default value and other properties of a table column. To + set the properties of an individual column, select the column + using the mouse. Alternatively, you can move through the grid + using <keycap>Tab</keycap> and <keycap>Shift+Tab</keycap> + keys. + </para> + + <itemizedlist> + + <listitem> + <para> + To set or change the name, data type, default value and + comment of a column, select the appropriate cell and edit + the desired value. + </para> + </listitem> + + <listitem> + <para> + To set or unset flag-type column properties (i.e., primary + key, <literal>NOT NULL</literal>, auto incremented, + flags), check or uncheck the corresponding checkboxes. + Note that the available column flags will depend on the + columns data type. + </para> + </listitem> + + <listitem> + <para> + To reorder columns, index columns or foreign key columns + in the Column Editor, select the whole column you wish to + reorder by clicking on the selector column at the left of + the column grid. Then move the column by using + <keycap>Ctrl+Up</keycap> (to move the column up) and + <keycap>Ctrl+Down</keycap> (to move the column down) keys. + </para> + </listitem> + + <listitem> + <para> + To delete a column, select it by clicking on the selector + column at the left of the column grid, then press the + <keycap>Delete</keycap> button on a keyboard. + </para> + </listitem> + + </itemizedlist> + + </section> + + <section id="connector-vstudio-using-tables-indexes"> + + <title>Indexes tab</title> + + <para> + Index management is performed via the Indexes tab. + </para> + + <itemizedlist> + + <listitem> + <para> + To add an index, press the <guibutton>+</guibutton> button + and set the properties in the <guilabel>Index + Settings</guilabel> groupbox at the right. You can set the + index name, index kind, index type and a set of index + columns. + </para> + </listitem> + + <listitem> + <para> + To remove an index, select the index from the list and + press the <guibutton>-</guibutton> button. + </para> + </listitem> + + <listitem> + <para> + To change index settings, select the index from the list; + detailed information about the index is displayed in the + <guilabel>Index Settings</guilabel> panel. + </para> + </listitem> + + </itemizedlist> + + <para> + You cannot change a table column to an index column using drag + and drop. Instead, you can add new index columns to a table + and set their table columns by using the embedded editor + within the Indexes tab + </para> + + </section> + + <section id="connector-vstudio-using-tables-foreignkeys"> + + <title>Foreign Keys tab</title> + + <para> + Foreign Key management is performed via the Foreign Keys tab. + </para> + + <itemizedlist> + + <listitem> + <para> + To add a foreign key, press the <guibutton>+</guibutton> + button and set properties in the <guilabel>Foreign Keys + Settings</guilabel> panel. You can set the foreign key + name, referenced table name, foreign key columns and + actions on update and delete. + </para> + </listitem> + + <listitem> + <para> + To remove a foreign key, select the foreign key and press + the <guibutton>-</guibutton> button. + </para> + </listitem> + + <listitem> + <para> + To change foreign key settings, select the foreign key and + use the <guilabel>Foreign Keys Settings</guilabel> panel + to edit the properties. + </para> + </listitem> + + <listitem> + <para> + When a foreign key is changed, the MySQL DDEX Provider + generates two queries: the first query drops the changed + keys and the second one recreates the new values. The + reason for such a behavior is to avoid the Bug #8377 and + Bug #8919. + </para> + </listitem> + + </itemizedlist> + + <note> + <para> + If changed values are for some reason inconsistent and cause + the second query to fail, all affected foreign keys will be + dropped. If this is the case, the MySQL DDEX Provider will + mark them as new in the Table Editor, and you will have to + recreate them later. But if you close the Table Editor + without saving, these foreign keys will be lost. + </para> + </note> + + </section> + + <section id="connector-vstudio-using-tables-column"> + + <title>Column Details tab</title> + + <para> + The Column Details tab can be used to set column options. + Besides the main column properties that are presented in the + Column Editor, in the Column Details tab you can set two + additional properties options: the character set and the + collation sequence. + </para> + + </section> + + <section id="connector-vstudio-using-tables-properties"> + + <title>Table Properties window</title> + + <para> + There is no separate tab for table options and advanced + options. All table options can be browsed and changed using + the <guilabel>Properties</guilabel> window of Visual Studio + 2005. + </para> + + <para> + The following table properties can be set: + </para> + + <itemizedlist> + + <listitem> + <para> + <guilabel> Auto Increment</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Average Row Length</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Character Set</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Checksum for Rows</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Collation</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Comment</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Connection</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Data Directory</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Delay Key Updates</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Engine</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Index Directory</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Insert Method</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Maximum Rows</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Minimum Rows</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Name</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Pack Keys</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Password</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Row Format</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Union</guilabel> + </para> + </listitem> + + </itemizedlist> + + <para> + Some of these properties can have arbitrary text values, + others accept values from a predefined set. + </para> + + <para> + The properties <guilabel>Schema</guilabel> and + <guilabel>Server</guilabel> are read only. + </para> + + </section> + + </section> + + <section id="connector-vstudio-using-tabledata"> + + <title>Editing Table Data</title> + + <para> + The Table Data Editor, allows a user to browse, create and edit + data of tables. The Table Data Editor is implemented as a simple + data grid with auto generated columns. + </para> + + <para> + To access the Table Data Editor, right click on a node + representing the table or view in Server Explorer. From the + nodes context menu, choose the <guimenu>Browse</guimenu> or + <guimenu>Edit Data</guimenu> command. For tables and updatable + views, this command opens the Table Data Editor in edit mode. + For non-updatable views, this command opens the Table Data + Editor in read-only mode. + </para> + + <para> + When in the edit mode, you can modify table data by modifying + the displayed table contents directly. To add a row, set desired + values in the last row of the grid. To modify values, set new + values in appropriate cells. To delete a row, select it by + clicking on the selector column at the left of the grid, then + press the <guibutton>Delete</guibutton> button. + </para> + + <para> + To save changes you have made in the Table Data Editor, use + either <guibutton>Save</guibutton> or <guibutton>Save + All</guibutton> buttons of the Visual Studio main toolbar, or + just press <keycap>Ctrl+S</keycap>. A confirmation dialog will + confirm whether you want the changes saved to the database. + </para> + + </section> + + <section id="connector-vstudio-using-views"> + + <title>Editing Views</title> + + <para> + To create a new view, right click the Views node under the + connection node in Server Explorer. From the nodes context menu, + choose the <guimenu>Create View</guimenu> command. This command + opens the SQL Editor. + </para> + + <para> + To modify an existing view, double click on a node of the view + you wish to modify, or right click on this node and choose the + <guimenu>Alter View</guimenu> command from a context menu. + Either of the commands opens the SQL Editor. + </para> + + <para> + To create or alter the view definition using SQL Editor, type + the appropriate SQL statement in the SQL Editor. + </para> + + <note> + <para> + You should enter only the defining statement itself, without + the <literal> CREATE VIEW AS</literal> preface. + </para> + </note> + + <para> + All other view properties can be set in the + <guilabel>Properties</guilabel> window. These properties are: + </para> + + <itemizedlist> + + <listitem> + <para> + <guilabel>Algorithm</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Check Option</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Definer</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Name</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Security Type</guilabel> + </para> + </listitem> + + </itemizedlist> + + <para> + Some of these properties can have arbitrary text values, others + accept values from a predefined set. + </para> + + <para> + The properties <guilabel>Is Updatable</guilabel>, + <guilabel>Schema</guilabel> and <guilabel>Server</guilabel> are + readonly. + </para> + + <para> + To save changes you have made, use either + <guibutton>Save</guibutton> or <guibutton>Save All</guibutton> + buttons of the Visual Studio main toolbar, or just press + <keycap>Ctrl+S</keycap>. A confirmation dialog will confirm + whether you want the changes saved to the database. + </para> + + </section> + + <section id="connector-vstudio-using-storedroutines"> + + <title>Editing Stored Procedures and Functions</title> + + <para> + To create a new stored procedure, right click the Stored + Procedures node under the connection node in Server Explorer. + From the nodes context menu, choose the <guimenu>Create + Routine</guimenu> command. This command opens the SQL Editor. + </para> + + <para> + To create a new stored function, right click the + <guilabel>Functions</guilabel> node under the connection node in + Server Explorer. From the node's context menu, choose the + <guimenu>Create Routine</guimenu> command. + </para> + + <para> + To modify an existing stored routine (procedure or function), + double click on a node of the routine you wish to modify, or + right click on this node and choose the <guimenu>Alter Routine + </guimenu>command from a context menu. Either of the commands + opens the SQL Editor. + </para> + + <para> + To create or alter the routine definition using SQL Editor, type + this definition in the SQL Editor using standard SQL. + </para> + + <para> + All other routine properties can be set in the + <guilabel>Properties</guilabel> window. These properties are: + </para> + + <itemizedlist> + + <listitem> + <para> + Comment + </para> + </listitem> + + <listitem> + <para> + Data Access + </para> + </listitem> + + <listitem> + <para> + Definer + </para> + </listitem> + + <listitem> + <para> + Is Deterministic + </para> + </listitem> + + <listitem> + <para> + Security Type + </para> + </listitem> + + </itemizedlist> + + <para> + Some of these properties can have arbitrary text values, others + accept values only from a predefined set. + </para> + + <para> + Also you can set all the options directly in the SQL Editor, + using the standard <literal>CREATE PROCEDURE</literal> or + <literal>CREATE FUNCTION</literal> statement. However, it is + recommended to use the <guilabel>Properties</guilabel> window + instead. + </para> + + <note> + <para> + You should never add the <literal>CREATE</literal> preface to + the routine definition. + </para> + </note> + + <para> + The properties <guilabel>Name</guilabel>, + <guilabel>Schema</guilabel> and <guilabel>Server</guilabel> in + the <guilabel>Properties</guilabel> window are read-only. Set or + change the procedure name in the SQL editor. + </para> + + <para> + To save changes you have made, use either + <guibutton>Save</guibutton> or <guibutton>Save All</guibutton> + buttons of the Visual Studio main toolbar, or just press + <keycap>Ctrl+S</keycap>. A confirmation dialog will confirm + whether you want the changes saved to the database.. + </para> + + </section> + + <section id="connector-vstudio-using-triggers"> + + <title>Editing Triggers</title> + + <para> + To create a new trigger, right click on a node of a table for + which you wish to add a trigger. From the node's context menu, + choose the <guimenu>Create Trigger</guimenu> command. This + command opens the SQL Editor. + </para> + + <para> + To modify an existing trigger, double click on a node of the + trigger you wish to modify, or right click on this node and + choose the <guimenu>Alter Trigger</guimenu> command from a + context menu. Either of the commands opens the SQL Editor. + </para> + + <para> + To create or alter the trigger definition using SQL Editor, type + the trigger statement in the SQL Editor using standard SQL. + </para> + + <note> + <para> + You should enter only the trigger statement, that is the part + of the <literal>CREATE TRIGGER</literal> query that is placed + after the <literal>FOR EACH ROW</literal> clause. + </para> + </note> + + <para> + All other trigger properties are set in the + <guilabel>Properties</guilabel> window. These properties are: + </para> + + <itemizedlist> + + <listitem> + <para> + <guilabel>Definer</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Event Manipulation</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Name</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Timing</guilabel> + </para> + </listitem> + + </itemizedlist> + + <para> + Some of these properties can have arbitrary text values, others + accept values only from a predefined set. + </para> + + <para> + The properties <guilabel>Event Table</guilabel>, + <guilabel>Schema</guilabel> and <guilabel>Server</guilabel> in + the <guilabel>Properties</guilabel> window are read-only. + </para> + + <para> + To save changes you have made, use either + <guibutton>Save</guibutton> or <guibutton>Save All</guibutton> + buttons of the Visual Studio main toolbar, or just press + <keycap>Ctrl+S</keycap>. A confirmation dialog will confirm + whether you want the changes saved to the database. + </para> + + </section> + + <section id="connector-vstudio-using-udf"> + + <title>Editing User Defined Functions (UDF)</title> + + <para> + To create a new User Defined Function (UDF), right click the + UDFs node under the connection node in Server Explorer. From the + node's context menu, choose the <guimenu>Create UDF</guimenu> + command. This command opens the UDF Editor. + </para> + + <para> + To modify an existing UDF, double click on a node of the UDF you + wish to modify, or right click on this node and choose the Alter + UDF command from a context menu. Either of the commands opens + the UDF Editor. + </para> + + <para> + The UDF editor allows you to set the following properties + through the properties panel: + </para> + + <itemizedlist> + + <listitem> + <para> + <guilabel>Name</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>So-name (DLL name)</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Return type</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Is Aggregate</guilabel> + </para> + </listitem> + + </itemizedlist> + + <para> + The property Server in the <guilabel>Properties</guilabel> + window is read-only. + </para> + + <para> + To save changes you have made, use either + <guibutton>Save</guibutton> or <guibutton>Save All</guibutton> + buttons of the Visual Studio main toolbar, or just press + <keycap>Ctrl+S</keycap>. A confirmation dialog will confirm + whether you want the changes saved to the database. + </para> + + </section> + + <section id="connector-vstudio-using-dropping"> + + <title>Dropping database objects</title> + + <para> + Tables, views, stored routines, triggers, an UDFs can be dropped + with the appropriate <guimenu>Drop</guimenu> command from its + context menu: <guimenu>Drop Table</guimenu>, <guimenu>Drop + View</guimenu>, <guimenu>Drop Routine</guimenu>, <guimenu>Drop + Trigger</guimenu>, <guimenu>Drop UDF</guimenu>. + </para> + + <para> + You will be asked to confirm the execution of the corresponding + drop query in a confirmation dialog. + </para> + + <para> + Dropping of multiple objects is not supported. + </para> + + </section> + + <section id="connector-vstudio-using-cloning"> + + <title>Cloning database objects</title> + + <para> + Tables, views, stored procedures and functions can be cloned + with the appropriate <guimenu>Clone</guimenu> command from its + context menu: <guimenu>Clone Table</guimenu>, <guimenu>Clone + View</guimenu>, <guimenu>Clone Routine</guimenu>. The clone + commands open the corresponding editor for a new object: the + <guilabel>Table Editor </guilabel>for cloning a table and the + SQL Editor for cloning a view or a routine. + </para> + + <para> + To save the cloned object, use either + <guibutton>Save</guibutton> or <guibutton>Save All</guibutton> + buttons of the Visual Studio main toolbar, or just press + <keycap>Ctrl+S</keycap>. A confirmation dialog will confirm + whether you want the changes saved to the database. + </para> + + </section> + + </section> + + <section id="connector-vstudio-support"> + + <title>Visual Studio Plugin Support</title> + + <para> + If you have a comment, or if you discover a bug, please, use our + MySQL bug tracking system + (<ulink url="http://bugs.mysql.com">http://bugs.mysql.com</ulink>) + to report problem or add your suggestion. + </para> + + </section> + +</section> Added: trunk/refman-5.0/images/mysql-vstudioplugin-1.png =================================================================== Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 329 bytes Added: trunk/refman-5.0/images/mysql-vstudioplugin-2.png =================================================================== Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 329 bytes Added: trunk/refman-5.0/images/mysql-vstudioplugin-3.png =================================================================== Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 329 bytes Added: trunk/refman-5.0/images/mysql-vstudioplugin-4.png =================================================================== Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 329 bytes Added: trunk/refman-5.1/connector-vstudioplugin.xml =================================================================== --- trunk/refman-5.1/connector-vstudioplugin.xml (rev 0) +++ trunk/refman-5.1/connector-vstudioplugin.xml 2006-12-12 15:16:27 UTC (rev 4219) Changed blocks: 1, Lines Added: 1320, Lines Deleted: 0; 40296 bytes @@ -0,0 +1,1320 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent"> + %fixedchars.entities; +]> +<section id="connector-vstudio"> + + <title>MySQL Visual Studio Plugin</title> + + <para> + The MySQL Visual Studio Plugin is a DDEX provider; a plug-in for + Visual Studio 2005 that allows developers to maintain database + structures, and supports built-in data-driven application + development tools. + </para> + + <para> + The current version of the MySQL Visual Studio Pluginincludes only + database maintenance tools. Data-driven application development + tools are not supported. + </para> + + <para> + The MySQL DDEX Provider operates as a standard extension to the + Visual Studio Data Designer functionality available through the + Server Explorer menu of Visual Studio 2005, and enables developers + to create database objects and data within a MySQL database. + </para> + + <para> + The MySQL DDEX Provider is designed to work with MySQL version 5.0, + but is also compatible with MySQL 4.1.1 and provides limited + compatibility with MySQL 5.1. + </para> + + <section id="connector-vstudio-install"> + + <title>Installing the MySQL Visual Studio Plugin</title> + + <para> + The MySQL DDEX Provider requires Visual Studio 2005 Professional + Edition to be installed, and therefore it has the same hardware + and system requirements. + </para> + + <para> + Here is the list of components that should already be installed + before starting the installation of the MySQL DDEX Provider: + </para> + + <itemizedlist> + + <listitem> + <para> + Visual Studio 2005 Standard, Professional or Team Developer + Edition. + </para> + </listitem> + + <listitem> + <para> + MySQL Server 4.1.1 or later (either installed on the same + machine, or a separate server). + </para> + </listitem> + + <listitem> + <para> + MySQL Connector.NET 5.0. + </para> + </listitem> + + </itemizedlist> + + <para> + The user used to connect to the MySQL server must have the + following privileges to use the functionality provided by the + MySQL DDEX Provider: + </para> + + <itemizedlist> + + <listitem> + <para> + The <literal>SELECT</literal> privilege for the + <literal>INFORMATION_SCHEMA</literal> database. + </para> + </listitem> + + <listitem> + <para> + The <literal>EXECUTE</literal> privilege for the <literal>SHOW + CREATE TABLE</literal> statement. + </para> + </listitem> + + <listitem> + <para> + The <literal>SELECT</literal> privilege for the + <literal>mysql.proc</literal> table (required for operations + with stored procedures and functions). + </para> + </listitem> + + <listitem> + <para> + The <literal>SELECT</literal> privilege for the + <literal>mysql.func</literal> table (required for operations + with User Defined Functions (UDF)). + </para> + </listitem> + + <listitem> + <para> + The <literal>EXECUTE</literal> privilege for the <literal>SHOW + ENGINE STATUS</literal> statement (required for retrieving + extended error information). + </para> + </listitem> + + <listitem> + <para> + Appropriate privileges for performed operations (e.g. the + <literal>SELECT</literal> privilege is required to browse data + from a table etc.). + </para> + </listitem> + + </itemizedlist> + + <para> + The MySQL DDEX Provider is delivered as a MSI package that can be + used to install, uninstall or reinstall the Provider. If you are + not using Windows XP or Windows Server 2003 you upgrade the + Windows Installer system to the latest version (see + <ulink url="http://support.microsoft.com/default.aspx?scid=kb;EN-US;292539">http://support.microsoft.com/default.aspx?scid=kb;EN-US;292539</ulink> + for details). + </para> + + <para> + The MSI-package is named <filename>MySQL-DDEX.msi</filename>. To + install the MySQL DDEX Provider, right click on the MSI file and + select <guimenu>Install</guimenu>. The installation process is as + follow: + </para> + + <orderedlist> + + <listitem> + <para> + The standard Welcome dialog is opened. Click Next to continue + installation. + </para> + </listitem> + + <listitem> + <para> + The License agreement (GNU GPL) window is opened. Accept the + agreement and click <guibutton>Next</guibutton> to continue. + </para> + </listitem> + + <listitem> + <para> + The destination folder choice dialog is opened. Here you can + point out the folder where the MySQL DDEX Provider will be + installed. The default destination folder is + <filename>%ProgramFilesDir%\MySQL\MySQL DDEX Data + Provider</filename>, where + <filename>%ProgramFilesDir%</filename> is the Program Files + folder of the installation machine. After choosing the + destination folder, click <guibutton>Next</guibutton> to + continue. + </para> + </listitem> + + <listitem> + <para> + The installer will ask to confirm that installation. Click + Install to start installation process. + </para> + </listitem> + + <listitem> + <para> + The installation will now take place. At the end of this step + the Visual Studio command table is rebuilt (this process may + take several minutes). + </para> + </listitem> + + <listitem> + <para> + Once installation is complete, click + <guibutton>Finish</guibutton> to end the installation process. + </para> + </listitem> + + </orderedlist> + + <para> + To uninstall the MySQL DDEX Provider, you can use either + Add/Remove Programs component of the Control Panel or the same + MSI-package. Choose the <guilabel>Remove</guilabel> option, and + the Provider will be uninstalled automatically. + </para> + + <para> + To repair the Provider, right click the MSI-package and choose the + <guimenu>Repair</guimenu> option. The MySQL DDEX Provider will be + repaired automatically. + </para> + + <para> + The installation package includes the following files: + </para> + + <itemizedlist> + + <listitem> + <para> + <filename>MySQL.VisualStudio.dll</filename> — the MySQL + DDEX Provider assembly. + </para> + </listitem> + + <listitem> + <para> + <filename>MySQL.Data.dll</filename> — the assembly + containing the MySQL Connector .NET which is used by the + Provider. + </para> + </listitem> + + <listitem> + <para> + <filename>MySql.VisualStudio.dll.config</filename> — the + configuration file for the MySQL DDEX Provider. This file + contains default values for the provider GUI layout. + </para> + + <note> + <para> + Do not remove this file before the first use of the + Provider. + </para> + </note> + </listitem> + + <listitem> + <para> + <filename>Register.reg</filename> — the file with + registry entries that can be used to register the MySQL DDEX + Provider in the case of the manual installation. + </para> + </listitem> + + <listitem> + <para> + <filename>Install.js</filename> — the script used to + register the Connector .NET as an ADO.NET data provider in the + machine.config file. + </para> + </listitem> + + <listitem> + <para> + <filename>Release notes.doc</filename> — the document + with release notes. + </para> + </listitem> + + </itemizedlist> + + <para> + To install the Provider manually, copy all files of the + installation package in a desired folder, then set the full path + to the Provider assembly as a value of the CodeBase entry. For + example: + </para> + +<programlisting>[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\8.0\Packages\{79A115C9-B133-4891-9E7B-242509DAD272}]@="MySql.Data.VisualStudio.MySqlDataProviderPackage" +"InprocServer32"="C:\\WINNT\\system32\\mscoree.dll" +"Class"="MySql.Data.VisualStudio.MySqlDataProviderPackage" +"CodeBase"="C:\\MySqlDdexProvider\\MySql.VisualStudio.dll" +</programlisting> + + <para> + Then import information from the Register.reg file to the registry + by clicking of the file. At the confirmation dialog choose Yes. + Next you must run the command devenv.exe /setup within a Command + Prompt to rebuild the Visual Studio command table. + </para> + + </section> + + <section id="connector-vstudio-creating"> + + <title>Creating a connection to the MySQL server</title> + + <para> + Once the MySQL DDEX Provider is installed, you can use it to + create, modify and delete connections to MySQL databases. To + create a connection with a MySQL database, perform the following + steps: + </para> + + <orderedlist> + + <listitem> + <para> + Start Visual Studio 2005 and open Server Explorer window by + choosing the <guimenu>Server Explorer</guimenu> option from + the <guimenu>View</guimenu> menu. + </para> + </listitem> + + <listitem> + <para> + Right click on the <guilabel>Data Connections</guilabel> node + and choose the <guibutton>Add Connection</guibutton> button. + </para> + </listitem> + + <listitem> + <para> + The Add Connection dialog is opened. Press the + <guibutton>Change</guibutton> button to choose MySQL Database + as a data source. + </para> + </listitem> + + <listitem> + <para> + Change Data Source dialog is opened. Choose MySQL Database in + the list of data sources (or the <literal>other</literal> + option, if MySQL Database is absent), and then choose + <guilabel>.NET Framework Data Provider for MySQL</guilabel> in + the combo box of data providers. + </para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/mysql-vstudioplugin-1.png" format="PNG"/> + </imageobject> + <textobject> + <phrase lang="en">Choosing a data source</phrase> + </textobject> + </mediaobject> + + <para> + Press <guibutton>OK</guibutton> to confirm your choice. + </para> + </listitem> + + <listitem> + <para> + Enter the connection settings: the server host name (for + example, localhost if the MySQL server is installed on the + local machine), the user name, the password, and the default + database schema. Note that you must specify the default schema + name to open the connection. + </para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/mysql-vstudioplugin-1.png" format="PNG"/> + </imageobject> + <textobject> + <phrase lang="en">Setting connection properties</phrase> + </textobject> + </mediaobject> + </listitem> + + <listitem> + <para> + You can also set the port to connect with the MySQL server by + pressing the <guibutton>Advanced</guibutton> button. To test a + connection with the MySQL server, ser the server host name, + the user name, and the password, and press the <guibutton>Test + Connection</guibutton> button. If the test fails, check the + connection values that you have supplied are correct and that + the corresponding user and privileges have been configured on + the MySQL server. + </para> + </listitem> + + <listitem> + <para> + After you set all settings and test the connection, press + <guibutton>OK</guibutton>. The newly created connection is + displayed in Server Explorer. Now you can work with the MySQL + server through standard Server Explorer interface. + </para> + </listitem> + + </orderedlist> + + <para> + After a connection is successfully established, all the connection + settings are saved. When you next open Visual Studio, the + connection to the MySQL server will appear within Server Explorer + so that you can re-establish a connection to the MySQL server. + </para> + + <para> + To modify and delete a connection, use the <guimenu>Server + Explorer</guimenu> context menu for the corresponding node. You + can modify any of the settings just by overwriting the existing + values with new ones. Note that a connection should be modified or + deleted only if no active editor for it's objects is opened. + Otherwise your data could be lost. + </para> + + </section> + + <section id="connector-vstudio-using"> + + <title>Using the MySQL DDEX Provider</title> + + <para> + To work with a MySQL server using the MySQL DDEX Provider, open + the Visual Studio 2005, open the <guilabel>Server + Explorer</guilabel>, and select the required connection. The + working area of the MySQL DDEX Provider consists of three parts. + </para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/mysql-vstudioplugin-3.png" format="PNG"/> + </imageobject> + <textobject> + <phrase lang="en">DDEX enviroment</phrase> + </textobject> + </mediaobject> + + <itemizedlist> + + <listitem> + <para> + Database objects (tables, views, stored routines, triggers, + and user defined functions) are displayed in the Server + Explorer tree. Here you can choose an object and edit its + properties and definition. + </para> + </listitem> + + <listitem> + <para> + Properties of a selected database object are displayed in the + <guilabel>Properties</guilabel> panel. Certain properties can + be edited directly within this window. + </para> + </listitem> + + <listitem> + <para> + The editor panel provides direct access to the SQL statement + and definition of specific objects. Fore example, the SQL + statements within a stored procedure definition are shown and + edited within this panel. + </para> + </listitem> + + </itemizedlist> + + <section id="connector-vstudio-using-tables"> + + <title>Editing Tables</title> + + <para> + The Table Editor can be accessed through a mouse action on + table-type node of Server Explorer. To create a new table, right + click on the <guilabel>Tables</guilabel> node (under the + connection node) and choose the <guimenu>Create Table</guimenu> + command from a context menu. To modify an existing table, double + click on a node of the table you wish to modify, or right click + on this node and choose the <guimenu>Alter Table</guimenu> + command from a context menu. Either of the commands opens the + Table Editor. + </para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/mysql-vstudioplugin-4.png" format="PNG"/> + </imageobject> + <textobject> + <phrase lang="en">Editing a table</phrase> + </textobject> + </mediaobject> + + <para> + The MySQL DDEX Provider Table Editor is implemented in a similar + fashion to the standard Query Browser Table Editor, but with + minor differences. + </para> + + <para> + The Table Editor consists of the following parts: + </para> + + <itemizedlist> + + <listitem> + <para> + Columns Editor — for column creation, modification and + deletion. + </para> + </listitem> + + <listitem> + <para> + Indexes tab — for table/column index management. + </para> + </listitem> + + <listitem> + <para> + Foreign Keys tab — for configuration of foreign keys. + </para> + </listitem> + + <listitem> + <para> + Column Details tab — used to set advanced column + options. + </para> + </listitem> + + <listitem> + <para> + Properties window — used to set table properties. + </para> + </listitem> + + </itemizedlist> + + <para> + To save changes you have made in the Table Editor, use either + Save or Save All buttons of the Visual Studio main toolbar, or + just press <keycap>Ctrl+S</keycap>. Before changes are saved, a + confirmation dialog will be displayed to confirm that you want + to update the corresponding object within the MySQL database. + </para> + + <section id="connector-vstudio-using-tables-columns"> + + <title>Column Editor</title> + + <para> + You can use the Column Editor to set or change the name, data + type, default value and other properties of a table column. To + set the properties of an individual column, select the column + using the mouse. Alternatively, you can move through the grid + using <keycap>Tab</keycap> and <keycap>Shift+Tab</keycap> + keys. + </para> + + <itemizedlist> + + <listitem> + <para> + To set or change the name, data type, default value and + comment of a column, select the appropriate cell and edit + the desired value. + </para> + </listitem> + + <listitem> + <para> + To set or unset flag-type column properties (i.e., primary + key, <literal>NOT NULL</literal>, auto incremented, + flags), check or uncheck the corresponding checkboxes. + Note that the available column flags will depend on the + columns data type. + </para> + </listitem> + + <listitem> + <para> + To reorder columns, index columns or foreign key columns + in the Column Editor, select the whole column you wish to + reorder by clicking on the selector column at the left of + the column grid. Then move the column by using + <keycap>Ctrl+Up</keycap> (to move the column up) and + <keycap>Ctrl+Down</keycap> (to move the column down) keys. + </para> + </listitem> + + <listitem> + <para> + To delete a column, select it by clicking on the selector + column at the left of the column grid, then press the + <keycap>Delete</keycap> button on a keyboard. + </para> + </listitem> + + </itemizedlist> + + </section> + + <section id="connector-vstudio-using-tables-indexes"> + + <title>Indexes tab</title> + + <para> + Index management is performed via the Indexes tab. + </para> + + <itemizedlist> + + <listitem> + <para> + To add an index, press the <guibutton>+</guibutton> button + and set the properties in the <guilabel>Index + Settings</guilabel> groupbox at the right. You can set the + index name, index kind, index type and a set of index + columns. + </para> + </listitem> + + <listitem> + <para> + To remove an index, select the index from the list and + press the <guibutton>-</guibutton> button. + </para> + </listitem> + + <listitem> + <para> + To change index settings, select the index from the list; + detailed information about the index is displayed in the + <guilabel>Index Settings</guilabel> panel. + </para> + </listitem> + + </itemizedlist> + + <para> + You cannot change a table column to an index column using drag + and drop. Instead, you can add new index columns to a table + and set their table columns by using the embedded editor + within the Indexes tab + </para> + + </section> + + <section id="connector-vstudio-using-tables-foreignkeys"> + + <title>Foreign Keys tab</title> + + <para> + Foreign Key management is performed via the Foreign Keys tab. + </para> + + <itemizedlist> + + <listitem> + <para> + To add a foreign key, press the <guibutton>+</guibutton> + button and set properties in the <guilabel>Foreign Keys + Settings</guilabel> panel. You can set the foreign key + name, referenced table name, foreign key columns and + actions on update and delete. + </para> + </listitem> + + <listitem> + <para> + To remove a foreign key, select the foreign key and press + the <guibutton>-</guibutton> button. + </para> + </listitem> + + <listitem> + <para> + To change foreign key settings, select the foreign key and + use the <guilabel>Foreign Keys Settings</guilabel> panel + to edit the properties. + </para> + </listitem> + + <listitem> + <para> + When a foreign key is changed, the MySQL DDEX Provider + generates two queries: the first query drops the changed + keys and the second one recreates the new values. The + reason for such a behavior is to avoid the Bug #8377 and + Bug #8919. + </para> + </listitem> + + </itemizedlist> + + <note> + <para> + If changed values are for some reason inconsistent and cause + the second query to fail, all affected foreign keys will be + dropped. If this is the case, the MySQL DDEX Provider will + mark them as new in the Table Editor, and you will have to + recreate them later. But if you close the Table Editor + without saving, these foreign keys will be lost. + </para> + </note> + + </section> + + <section id="connector-vstudio-using-tables-column"> + + <title>Column Details tab</title> + + <para> + The Column Details tab can be used to set column options. + Besides the main column properties that are presented in the + Column Editor, in the Column Details tab you can set two + additional properties options: the character set and the + collation sequence. + </para> + + </section> + + <section id="connector-vstudio-using-tables-properties"> + + <title>Table Properties window</title> + + <para> + There is no separate tab for table options and advanced + options. All table options can be browsed and changed using + the <guilabel>Properties</guilabel> window of Visual Studio + 2005. + </para> + + <para> + The following table properties can be set: + </para> + + <itemizedlist> + + <listitem> + <para> + <guilabel> Auto Increment</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Average Row Length</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Character Set</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Checksum for Rows</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Collation</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Comment</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Connection</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Data Directory</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Delay Key Updates</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Engine</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Index Directory</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Insert Method</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Maximum Rows</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Minimum Rows</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Name</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Pack Keys</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Password</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Row Format</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Union</guilabel> + </para> + </listitem> + + </itemizedlist> + + <para> + Some of these properties can have arbitrary text values, + others accept values from a predefined set. + </para> + + <para> + The properties <guilabel>Schema</guilabel> and + <guilabel>Server</guilabel> are read only. + </para> + + </section> + + </section> + + <section id="connector-vstudio-using-tabledata"> + + <title>Editing Table Data</title> + + <para> + The Table Data Editor, allows a user to browse, create and edit + data of tables. The Table Data Editor is implemented as a simple + data grid with auto generated columns. + </para> + + <para> + To access the Table Data Editor, right click on a node + representing the table or view in Server Explorer. From the + nodes context menu, choose the <guimenu>Browse</guimenu> or + <guimenu>Edit Data</guimenu> command. For tables and updatable + views, this command opens the Table Data Editor in edit mode. + For non-updatable views, this command opens the Table Data + Editor in read-only mode. + </para> + + <para> + When in the edit mode, you can modify table data by modifying + the displayed table contents directly. To add a row, set desired + values in the last row of the grid. To modify values, set new + values in appropriate cells. To delete a row, select it by + clicking on the selector column at the left of the grid, then + press the <guibutton>Delete</guibutton> button. + </para> + + <para> + To save changes you have made in the Table Data Editor, use + either <guibutton>Save</guibutton> or <guibutton>Save + All</guibutton> buttons of the Visual Studio main toolbar, or + just press <keycap>Ctrl+S</keycap>. A confirmation dialog will + confirm whether you want the changes saved to the database. + </para> + + </section> + + <section id="connector-vstudio-using-views"> + + <title>Editing Views</title> + + <para> + To create a new view, right click the Views node under the + connection node in Server Explorer. From the nodes context menu, + choose the <guimenu>Create View</guimenu> command. This command + opens the SQL Editor. + </para> + + <para> + To modify an existing view, double click on a node of the view + you wish to modify, or right click on this node and choose the + <guimenu>Alter View</guimenu> command from a context menu. + Either of the commands opens the SQL Editor. + </para> + + <para> + To create or alter the view definition using SQL Editor, type + the appropriate SQL statement in the SQL Editor. + </para> + + <note> + <para> + You should enter only the defining statement itself, without + the <literal> CREATE VIEW AS</literal> preface. + </para> + </note> + + <para> + All other view properties can be set in the + <guilabel>Properties</guilabel> window. These properties are: + </para> + + <itemizedlist> + + <listitem> + <para> + <guilabel>Algorithm</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel> Check Option</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Definer</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Name</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Security Type</guilabel> + </para> + </listitem> + + </itemizedlist> + + <para> + Some of these properties can have arbitrary text values, others + accept values from a predefined set. + </para> + + <para> + The properties <guilabel>Is Updatable</guilabel>, + <guilabel>Schema</guilabel> and <guilabel>Server</guilabel> are + readonly. + </para> + + <para> + To save changes you have made, use either + <guibutton>Save</guibutton> or <guibutton>Save All</guibutton> + buttons of the Visual Studio main toolbar, or just press + <keycap>Ctrl+S</keycap>. A confirmation dialog will confirm + whether you want the changes saved to the database. + </para> + + </section> + + <section id="connector-vstudio-using-storedroutines"> + + <title>Editing Stored Procedures and Functions</title> + + <para> + To create a new stored procedure, right click the Stored + Procedures node under the connection node in Server Explorer. + From the nodes context menu, choose the <guimenu>Create + Routine</guimenu> command. This command opens the SQL Editor. + </para> + + <para> + To create a new stored function, right click the + <guilabel>Functions</guilabel> node under the connection node in + Server Explorer. From the node's context menu, choose the + <guimenu>Create Routine</guimenu> command. + </para> + + <para> + To modify an existing stored routine (procedure or function), + double click on a node of the routine you wish to modify, or + right click on this node and choose the <guimenu>Alter Routine + </guimenu>command from a context menu. Either of the commands + opens the SQL Editor. + </para> + + <para> + To create or alter the routine definition using SQL Editor, type + this definition in the SQL Editor using standard SQL. + </para> + + <para> + All other routine properties can be set in the + <guilabel>Properties</guilabel> window. These properties are: + </para> + + <itemizedlist> + + <listitem> + <para> + Comment + </para> + </listitem> + + <listitem> + <para> + Data Access + </para> + </listitem> + + <listitem> + <para> + Definer + </para> + </listitem> + + <listitem> + <para> + Is Deterministic + </para> + </listitem> + + <listitem> + <para> + Security Type + </para> + </listitem> + + </itemizedlist> + + <para> + Some of these properties can have arbitrary text values, others + accept values only from a predefined set. + </para> + + <para> + Also you can set all the options directly in the SQL Editor, + using the standard <literal>CREATE PROCEDURE</literal> or + <literal>CREATE FUNCTION</literal> statement. However, it is + recommended to use the <guilabel>Properties</guilabel> window + instead. + </para> + + <note> + <para> + You should never add the <literal>CREATE</literal> preface to + the routine definition. + </para> + </note> + + <para> + The properties <guilabel>Name</guilabel>, + <guilabel>Schema</guilabel> and <guilabel>Server</guilabel> in + the <guilabel>Properties</guilabel> window are read-only. Set or + change the procedure name in the SQL editor. + </para> + + <para> + To save changes you have made, use either + <guibutton>Save</guibutton> or <guibutton>Save All</guibutton> + buttons of the Visual Studio main toolbar, or just press + <keycap>Ctrl+S</keycap>. A confirmation dialog will confirm + whether you want the changes saved to the database.. + </para> + + </section> + + <section id="connector-vstudio-using-triggers"> + + <title>Editing Triggers</title> + + <para> + To create a new trigger, right click on a node of a table for + which you wish to add a trigger. From the node's context menu, + choose the <guimenu>Create Trigger</guimenu> command. This + command opens the SQL Editor. + </para> + + <para> + To modify an existing trigger, double click on a node of the + trigger you wish to modify, or right click on this node and + choose the <guimenu>Alter Trigger</guimenu> command from a + context menu. Either of the commands opens the SQL Editor. + </para> + + <para> + To create or alter the trigger definition using SQL Editor, type + the trigger statement in the SQL Editor using standard SQL. + </para> + + <note> + <para> + You should enter only the trigger statement, that is the part + of the <literal>CREATE TRIGGER</literal> query that is placed + after the <literal>FOR EACH ROW</literal> clause. + </para> + </note> + + <para> + All other trigger properties are set in the + <guilabel>Properties</guilabel> window. These properties are: + </para> + + <itemizedlist> + + <listitem> + <para> + <guilabel>Definer</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Event Manipulation</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Name</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Timing</guilabel> + </para> + </listitem> + + </itemizedlist> + + <para> + Some of these properties can have arbitrary text values, others + accept values only from a predefined set. + </para> + + <para> + The properties <guilabel>Event Table</guilabel>, + <guilabel>Schema</guilabel> and <guilabel>Server</guilabel> in + the <guilabel>Properties</guilabel> window are read-only. + </para> + + <para> + To save changes you have made, use either + <guibutton>Save</guibutton> or <guibutton>Save All</guibutton> + buttons of the Visual Studio main toolbar, or just press + <keycap>Ctrl+S</keycap>. A confirmation dialog will confirm + whether you want the changes saved to the database. + </para> + + </section> + + <section id="connector-vstudio-using-udf"> + + <title>Editing User Defined Functions (UDF)</title> + + <para> + To create a new User Defined Function (UDF), right click the + UDFs node under the connection node in Server Explorer. From the + node's context menu, choose the <guimenu>Create UDF</guimenu> + command. This command opens the UDF Editor. + </para> + + <para> + To modify an existing UDF, double click on a node of the UDF you + wish to modify, or right click on this node and choose the Alter + UDF command from a context menu. Either of the commands opens + the UDF Editor. + </para> + + <para> + The UDF editor allows you to set the following properties + through the properties panel: + </para> + + <itemizedlist> + + <listitem> + <para> + <guilabel>Name</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>So-name (DLL name)</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Return type</guilabel> + </para> + </listitem> + + <listitem> + <para> + <guilabel>Is Aggregate</guilabel> + </para> + </listitem> + + </itemizedlist> + + <para> + The property Server in the <guilabel>Properties</guilabel> + window is read-only. + </para> + + <para> + To save changes you have made, use either + <guibutton>Save</guibutton> or <guibutton>Save All</guibutton> + buttons of the Visual Studio main toolbar, or just press + <keycap>Ctrl+S</keycap>. A confirmation dialog will confirm + whether you want the changes saved to the database. + </para> + + </section> + + <section id="connector-vstudio-using-dropping"> + + <title>Dropping database objects</title> + + <para> + Tables, views, stored routines, triggers, an UDFs can be dropped + with the appropriate <guimenu>Drop</guimenu> command from its + context menu: <guimenu>Drop Table</guimenu>, <guimenu>Drop + View</guimenu>, <guimenu>Drop Routine</guimenu>, <guimenu>Drop + Trigger</guimenu>, <guimenu>Drop UDF</guimenu>. + </para> + + <para> + You will be asked to confirm the execution of the corresponding + drop query in a confirmation dialog. + </para> + + <para> + Dropping of multiple objects is not supported. + </para> + + </section> + + <section id="connector-vstudio-using-cloning"> + + <title>Cloning database objects</title> + + <para> + Tables, views, stored procedures and functions can be cloned + with the appropriate <guimenu>Clone</guimenu> command from its + context menu: <guimenu>Clone Table</guimenu>, <guimenu>Clone + View</guimenu>, <guimenu>Clone Routine</guimenu>. The clone + commands open the corresponding editor for a new object: the + <guilabel>Table Editor </guilabel>for cloning a table and the + SQL Editor for cloning a view or a routine. + </para> + + <para> + To save the cloned object, use either + <guibutton>Save</guibutton> or <guibutton>Save All</guibutton> + buttons of the Visual Studio main toolbar, or just press + <keycap>Ctrl+S</keycap>. A confirmation dialog will confirm + whether you want the changes saved to the database. + </para> + + </section> + + </section> + + <section id="connector-vstudio-support"> + + <title>Visual Studio Plugin Support</title> + + <para> + If you have a comment, or if you discover a bug, please, use our + MySQL bug tracking system + (<ulink url="http://bugs.mysql.com">http://bugs.mysql.com</ulink>) + to report problem or add your suggestion. + </para> + + </section> + +</section> Added: trunk/refman-5.1/images/mysql-vstudioplugin-1.png =================================================================== Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 329 bytes Added: trunk/refman-5.1/images/mysql-vstudioplugin-2.png =================================================================== Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 329 bytes Added: trunk/refman-5.1/images/mysql-vstudioplugin-3.png =================================================================== Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 329 bytes Added: trunk/refman-5.1/images/mysql-vstudioplugin-4.png =================================================================== Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 329 bytes
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r4219 - in trunk: refman-5.0 refman-5.0/images refman-5.1 refman-5.1/images | mcbrown | 12 Dec |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 1.332 sec. using MySQL 5.1.14-beta-log