Difference between revisions of "Database/Drivers/MySQL Native/Connector/C-OOo-Connect-URL"
(→Connection/Authentification) |
|||
| Line 3: | Line 3: | ||
'''All: please comment!''' | '''All: please comment!''' | ||
| − | This suggestion is based on the MySQL Connector/J documentation and [http://dev.mysql.com/doc/refman/5.1/en/mysql-real-connect.html the MySQL C-API documentation]. | + | This suggestion is based on the MySQL Connector/J documentation and [http://dev.mysql.com/doc/refman/5.1/en/mysql-real-connect.html the MySQL C-API documentation] as well as the [http://api.openoffice.org/docs/common/ref/com/sun/star/sdbc/XDriver.html#connect XDriver::connect] and related documentation. |
| − | === | + | === Connection URL === |
| − | <code>sdbc:mysqlc:://[host[:port]]/database | + | <code>sdbc:mysqlc:://[host[:port]]/database</code> |
| − | The value of host may be either a hostname or an IP address. If host is NULL or the string "localhost", a connection to the local host is assumed. For Windows, the client connects using a shared-memory connection, if the server has shared-memory connections enabled. Otherwise, TCP/IP is used. For Unix, the client connects using a Unix socket file. For local connections, you can also influence the type of connection to use with the MYSQL_OPT_PROTOCOL or MYSQL_OPT_NAMED_PIPE options to mysql_options(). The type of connection must be supported by the server. For a host value of "." on Windows, the client connects using a named pipe, if the server has named-pipe connections enabled. If named-pipe connections are not enabled, an error occurs. | + | The value of host may be either a hostname or an IP address. If host is NULL or the string "localhost", a connection to the local host is assumed. For Windows, the client connects using a shared-memory connection, if the server has shared-memory connections enabled. Otherwise, TCP/IP is used. For Unix, the client connects using a Unix socket file. |
| + | |||
| + | For local connections, you can also influence the type of connection to use with the MYSQL_OPT_PROTOCOL or MYSQL_OPT_NAMED_PIPE options to mysql_options(). The type of connection must be supported by the server. For a host value of "." on Windows, the client connects using a named pipe, if the server has named-pipe connections enabled. If named-pipe connections are not enabled, an error occurs. | ||
If the hostname is not specified, it defaults to 127.0.0.1 | If the hostname is not specified, it defaults to 127.0.0.1 | ||
| Line 17: | Line 19: | ||
If the database is not specified, the connection will be made with no default database. | If the database is not specified, the connection will be made with no default database. | ||
| − | === Connection | + | === Connection Properties === |
{| class="wikitable" | {| class="wikitable" | ||
| Line 26: | Line 28: | ||
! Supported in GUI | ! Supported in GUI | ||
|- | |- | ||
| − | | user | + | | string user |
| The user to connect as | | The user to connect as | ||
| | | | ||
| >= 2.4 | | >= 2.4 | ||
|- | |- | ||
| − | | password | + | | string password |
| The password to use when connecting | | The password to use when connecting | ||
| | | | ||
| >= 2.4 | | >= 2.4 | ||
|- | |- | ||
| − | | socket | + | | string socket |
| The UNIX domain socket or Windows named pipe to use when connecting | | The UNIX domain socket or Windows named pipe to use when connecting | ||
| If socket is not empty, the string specifies the socket or named pipe that should be used. Note that the host parameter determines the type of the connection. | | If socket is not empty, the string specifies the socket or named pipe that should be used. Note that the host parameter determines the type of the connection. | ||
| >= 3.0 | | >= 3.0 | ||
|- | |- | ||
| − | | | + | | long ConnectionTimeout |
| | | | ||
| See also [http://dev.mysql.com/doc/refman/5.1/en/mysql-options.html mysql_options()] | | See also [http://dev.mysql.com/doc/refman/5.1/en/mysql-options.html mysql_options()] | ||
| >= 3.1 | | >= 3.1 | ||
|- | |- | ||
| − | | | + | | string Charset |
| The name of the character set to use as the default character set. | | The name of the character set to use as the default character set. | ||
| See also [http://dev.mysql.com/doc/refman/5.1/en/mysql-options.html mysql_options()] | | See also [http://dev.mysql.com/doc/refman/5.1/en/mysql-options.html mysql_options()] | ||
| >= 3.1 | | >= 3.1 | ||
|- | |- | ||
| − | | debug | + | | boolean debug |
| | | | ||
| Turn on debug output - TBD | | Turn on debug output - TBD | ||
| >= 3.1 | | >= 3.1 | ||
|- | |- | ||
| − | | compression | + | | boolean compression |
| Use compression protocol | | Use compression protocol | ||
| − | | | + | | See also [http://dev.mysql.com/doc/refman/5.1/en/mysql-real-connect.html CLIENT_COMPRESS] |
| >= 3.1 | | >= 3.1 | ||
|} | |} | ||
| Line 70: | Line 72: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| − | ! Property Name | + | ! Property Name and Type |
| − | ! Type | + | ! Meta Type |
! Constraints / Checks | ! Constraints / Checks | ||
! Comment | ! Comment | ||
|- | |- | ||
| − | | user | + | | string user |
| alphanumeric, >= 16 characters | | alphanumeric, >= 16 characters | ||
| none | | none | ||
| GUI may use a broader input field | | GUI may use a broader input field | ||
|- | |- | ||
| − | | password | + | | string password |
| alphanumeric, >= 32 characters | | alphanumeric, >= 32 characters | ||
| none | | none | ||
| GUI may use a broader input field | | GUI may use a broader input field | ||
|- | |- | ||
| − | | port | + | | integer port |
| numeric, 5 numbers | | numeric, 5 numbers | ||
| none | | none | ||
Revision as of 11:25, 14 May 2008
Contents
MySQL Connector/OpenOffice.org Connection URL
All: please comment!
This suggestion is based on the MySQL Connector/J documentation and the MySQL C-API documentation as well as the XDriver::connect and related documentation.
Connection URL
sdbc:mysqlc:://[host[:port]]/database
The value of host may be either a hostname or an IP address. If host is NULL or the string "localhost", a connection to the local host is assumed. For Windows, the client connects using a shared-memory connection, if the server has shared-memory connections enabled. Otherwise, TCP/IP is used. For Unix, the client connects using a Unix socket file.
For local connections, you can also influence the type of connection to use with the MYSQL_OPT_PROTOCOL or MYSQL_OPT_NAMED_PIPE options to mysql_options(). The type of connection must be supported by the server. For a host value of "." on Windows, the client connects using a named pipe, if the server has named-pipe connections enabled. If named-pipe connections are not enabled, an error occurs.
If the hostname is not specified, it defaults to 127.0.0.1
If the port is not specified, it defaults to 3306, the default port number for MySQL Servers
If the database is not specified, the connection will be made with no default database.
Connection Properties
| Property Name | Definition | Comments | Supported in GUI |
|---|---|---|---|
| string user | The user to connect as | >= 2.4 | |
| string password | The password to use when connecting | >= 2.4 | |
| string socket | The UNIX domain socket or Windows named pipe to use when connecting | If socket is not empty, the string specifies the socket or named pipe that should be used. Note that the host parameter determines the type of the connection. | >= 3.0 |
| long ConnectionTimeout | See also mysql_options() | >= 3.1 | |
| string Charset | The name of the character set to use as the default character set. | See also mysql_options() | >= 3.1 |
| boolean debug | Turn on debug output - TBD | >= 3.1 | |
| boolean compression | Use compression protocol | See also CLIENT_COMPRESS | >= 3.1 |
Support through the GUI
The OO.org GUI has been frozen for the 3.0 Release. No changes are possible.
The type column shows the meta type and the minimum input length that should be accepted by the GUI. The GUI may use broader input fields to beautify the layout. The GUI does not perform any input checks/validations prior to connecting to the MySQL Server. For example, the GUI will not warn the user when entering a user name with more than 16 characters although the MySQL Server might not support user names of more than 16 characters [[1]]
| Property Name and Type | Meta Type | Constraints / Checks | Comment |
|---|---|---|---|
| string user | alphanumeric, >= 16 characters | none | GUI may use a broader input field |
| string password | alphanumeric, >= 32 characters | none | GUI may use a broader input field |
| integer port | numeric, 5 numbers | none | GUI may use a broader input field |
| socket | alphanumeric, >= 32 characters | none | GUI may use a broader input field |
| connection_timeout | numeric, 4 numbers | none | GUI may use a broader input field |
| debug | alphanumeric, >= 64 characters | none | GUI may use a broader input field |
