db_set_active doc issues [#1184106]

Comment	File	Size	Author
#12	db_set_active_doc_issues-4598096-12.patch	706 bytes	barbi
#6	db_set_active_doc_issues-4598096-6.patch	705 bytes	barbi

Comment #1

aquariumtap commented 9 June 2011 at 22:01

[my original message seems to have been lost by using "preview"... here it is below]

It's unclear what "name" is, or where it's defined.

The answer: by default, the variable $db_url in settings.php is a single connection string. When multiple databases are configured, those strings are placed inside of an array. The key to each value is the "name".

For example:

$db_url = array(
  'default' => 'mysql://username:password@localhost/drupal_database',
  'thirdparty' => 'mysql://username1:password1@localhost/other_database'
  );

In the above sample from settings.php, the "name" would be either 'default' or 'thirdparty'.

Log in or register to post comments

Comment #2

jhodgdon

she/her

English

commented 13 June 2011 at 15:05

Issue tags:

+Novice

Thanks for reporting!

This is a d6-specific bug. In D7 it is documented more clearly (the parameter is called $key and it's documented what it's an array key to).

So we should say that $name is a key into the $db_url global variable from settings.php. Good project for a novice doc contributor...

Log in or register to post comments

Comment #3

jhodgdon

she/her

English

commented 13 June 2011 at 15:06

Title:

Documentation problem with db_set_active

» db_set_active doc issues

It would be great if the @return was fixed up too. non -> none, and needs to start with a capital letter.

Log in or register to post comments

Comment #4

jhodgdon

she/her

English

commented 13 June 2011 at 15:07

Just marked
#725856: db_set_active() documentation fix . . .
as a duplicate of this issue. It's about the @return section.

Log in or register to post comments

Comment #5

barbi commented 14 June 2011 at 03:58

sub

Log in or register to post comments

Comment #6

barbi commented 14 June 2011 at 04:46

Assigned:	Unassigned	» barbi
Status:	Active	» Needs review

Status	File	Size
new	db_set_active_doc_issues-4598096-6.patch	705 bytes

Log in or register to post comments

Comment #7

jhodgdon

she/her

English

commented 14 June 2011 at 14:43

Status:

Needs review

» Needs work

Close!

+ * The name of the previously active database or FALSE if None was found.
I think this needs a comma before the or, and None should not be capitalized. Sorry if my note about capital letters above confused you -- I meant the @return description needs to start with a capital letter, not the word none. :)