[ODBC-385] Wrong documentation for named pipes Created: 2023-02-28  Updated: 2023-03-08  Resolved: 2023-03-08

Status: Closed
Project: MariaDB Connector/ODBC
Component/s: Documentation, General
Affects Version/s: None
Fix Version/s: 3.2.0, 3.1.18

Type: Bug Priority: Major
Reporter: David Gausmann Assignee: Lawrin Novitsky
Resolution: Fixed Votes: 0
Labels: None


 Description   

To use the ODBC driver with named pipes on Windows I looked into the documentation and didn't get it to work.
https://mariadb.com/kb/en/about-mariadb-connector-odbc/

There are three sentences about named pipes:

Parameter Description
NAMEDPIPE boolean value(non-zero value is treated as TRUE) determining whether Server is treated as a named pipe name, or as domain name/IP address. Using of NAMEDPIPE is equivalent of setting/resetting of 13th bit(counting from 0, 8192) OPTIONS bit. It has effect on Windows only.
SOCKET full socket name, if it is specified, server name is disregarded. It has effect on Linux only.
SERVER name or IP of the MariaDB database server. Aliases: SERVERNAME

So my connection string should be (ADO):

Driver={MariaDB ODBC 3.1 Driver};NAMEDPIPE=1;SERVER=MyPipeName;USER=user;PASSWORD=password

But this doesn't work. Instead you always get this error:

[ma-3.1.17]Can't open named pipe to host: MyPipeName  pipe: MySQL (53)

The working connection string uses SOCKET instead of SERVER on Windows:

Driver={MariaDB ODBC 3.1 Driver};NAMEDPIPE=1;SOCKET=MyPipeName;USER=user;PASSWORD=password

This works fine. But the documentation explicitely says that "Server is treated as a named pipe name". Also the documentation for "Socket" says "It has effect on Linux only."
Both sentences are wrong.

It would be nice if you could fix the documentation.



 Comments   
Comment by Lawrin Novitsky [ 2023-03-08 ]

You are right - pipe name is taken from SOCKET parameter, and putting it into the SERVER won't work. Thus I think changing documentation is a better way in this case.

Comment by Lawrin Novitsky [ 2023-03-08 ]

It took also some fixes in the setup dialog, as it used SERVER for pipe name saving/connection test

Generated at Thu Feb 08 03:28:19 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.