Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update remnants of passwd and db also in docs #488

Merged
merged 1 commit into from
Sep 3, 2021
Merged

update remnants of passwd and db also in docs #488

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions doc/user_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,27 +125,27 @@ We haven't even begun to touch upon all the parameters ``connect()``
can take. For this reason, I prefer to use keyword parameters::

db=_mysql.connect(host="localhost",user="joebob",
passwd="moonpie",db="thangs")
password="moonpie",database="thangs")

This does exactly what the last example did, but is arguably easier to
read. But since the default host is "localhost", and if your login
name really was "joebob", you could shorten it to this::

db=_mysql.connect(passwd="moonpie",db="thangs")
db=_mysql.connect(password="moonpie",database="thangs")

UNIX sockets and named pipes don't work over a network, so if you
specify a host other than localhost, TCP will be used, and you can
specify an odd port if you need to (the default port is 3306)::

db=_mysql.connect(host="outhouse",port=3307,passwd="moonpie",db="thangs")
db=_mysql.connect(host="outhouse",port=3307,password="moonpie",database="thangs")

If you really had to, you could connect to the local host with TCP by
specifying the full host name, or 127.0.0.1.

Generally speaking, putting passwords in your code is not such a good
idea::

db=_mysql.connect(host="outhouse",db="thangs",read_default_file="~/.my.cnf")
db=_mysql.connect(host="outhouse",database="thangs",read_default_file="~/.my.cnf")

This does what the previous example does, but gets the username and
password and other parameters from ~/.my.cnf (UNIX-like systems). Read
Expand Down Expand Up @@ -561,7 +561,7 @@ Some examples
The ``connect()`` method works nearly the same as with `MySQLDB._mysql`_::

import MySQLdb
db=MySQLdb.connect(passwd="moonpie",db="thangs")
db=MySQLdb.connect(password="moonpie",database="thangs")

To perform a query, you first need a cursor, and then you can execute
queries on it::
Expand Down