Download & Extend
Issues

hook_schema() doc should state that database tables are auto-created

Posted by sven.lauer on October 18, 2011 at 4:15am
Project:Drupal core
Version:7.x-dev
Component:documentation
Category:bug report
Priority:normal
Assigned:Unassigned
Status:closed (fixed)
Issue tags:needs backport to D7, Novice, Quick fix

Issue Summary

The current api doc for hook_schema() does not mention at all that the database tables returned by implementations will be automatically created. Yes, everyone KNOWS that. Except those who don't. Strangely, the doc for hook_install() actually provides this information, but it really should be in the hook_schema doc as well.

(Will roll a patch.)

Login or register to post comments

Comments

#1

Posted by sven.lauer on October 18, 2011 at 5:21am
Assigned to:sven.lauer» Anonymous
Status:active» needs review

And a patch.

AttachmentSizeStatusTest resultOperations
doc-hook_schema-autoloaded-1312844-1.patch1.32 KBIdleFAILED: [[SimpleTest]]: [MySQL] Unable to apply patch doc-hook_schema-autoloaded-1312844-1.patch. This may be a -p0 (old style) patch, which is no longer supported by the testbots.View details

#2

Posted by jhodgdon on October 18, 2011 at 5:04pm
Status:needs review» reviewed & tested by the community

Thanks, this looks like a good addition to the docs! I also verified by looking at module_enable() and drupal_uninstall_modules() that the doc is correct about when things happen.

#3

Posted by webchick on October 20, 2011 at 6:49am

#1: doc-hook_schema-autoloaded-1312844-1.patch queued for re-testing.

#4

Posted by System Message on October 20, 2011 at 7:09am
Status:reviewed & tested by the community» needs work

The last submitted patch, doc-hook_schema-autoloaded-1312844-1.patch, failed testing.

#5

Posted by sven.lauer on October 20, 2011 at 7:46am
Status:needs work» needs review

Ah, I guess this patch conflicted with the one in #1307062: install file hooks should state whether module code is available. Re-rolling.

(If the testbot is happy, I'll set this back to RTBC, as nothing has changed.)

AttachmentSizeStatusTest resultOperations
doc-hook_schema-autoloaded-1312844-5.patch1.34 KBIdlePASSED: [[SimpleTest]]: [MySQL] 36,870 pass(es).View details

#6

Posted by jhodgdon on October 20, 2011 at 3:39pm
Status:needs review» reviewed & tested by the community

#7

Posted by catch on October 21, 2011 at 6:05am
Version:8.x-dev» 7.x-dev

Thanks! Committed to 8.x. Leaving RTBC for 7.

#8

Posted by catch on October 21, 2011 at 6:06am

#5: doc-hook_schema-autoloaded-1312844-5.patch queued for re-testing.

#9

Posted by webchick on October 25, 2011 at 3:04am
Status:reviewed & tested by the community» fixed

Committed and pushed to 7.x. Thanks!

#10

Posted by David_Rothstein on October 25, 2011 at 4:47pm
Status:fixed» needs work

+ * creation and alteration of the supported database engines *
  * See the Schema API Handbook at http://drupal.org/node/146843 for

Did someone type backspace when they meant to type a period?... Strange, they aren't even close to each other on the keyboard :)

#11

Posted by catch on October 25, 2011 at 4:48pm
Version:7.x-dev» 8.x-dev

Whoops.

#12

Posted by jhodgdon on October 25, 2011 at 9:31pm
Issue tags:+Novice

Whoops indeed. At least three of us missed that. Thanks David!

Good novice issue to fix that problem...

#13

Posted by kathyh on October 30, 2011 at 6:55pm
Status:needs work» needs review

Since patch from comment#5 was already committed, this patch corrects only comment #10.

AttachmentSizeStatusTest resultOperations
doc-hook_schema-autoloaded-1312844-13.patch712 bytesIdlePASSED: [[SimpleTest]]: [MySQL] 36,910 pass(es).View details

#14

Posted by David_Rothstein on October 30, 2011 at 7:32pm
Status:needs review» reviewed & tested by the community

Looks good, thanks :)

#15

Posted by jhodgdon on October 31, 2011 at 2:14pm

After committing, this needs to be D7 / to be ported, and a patch made combining #13 and #5. Thanks!

#16

Posted by David_Rothstein on October 31, 2011 at 2:37pm

I think #5 was already committed to D7, actually? (In which case this followup can just go into both D7 and D8 at the same time.)

#17

Posted by jhodgdon on October 31, 2011 at 3:12pm

True. :)

#18

Posted by catch on November 1, 2011 at 3:57am

#13: doc-hook_schema-autoloaded-1312844-13.patch queued for re-testing.

#19

Posted by System Message on November 1, 2011 at 3:58am
Status:reviewed & tested by the community» needs work

The last submitted patch, doc-hook_schema-autoloaded-1312844-13.patch, failed testing.

#20

Posted by kathyh on November 1, 2011 at 5:28am
Status:needs work» needs review

#13: doc-hook_schema-autoloaded-1312844-13.patch queued for re-testing.

#21

Posted by System Message on November 1, 2011 at 5:23pm
Status:needs review» needs work

The last submitted patch, doc-hook_schema-autoloaded-1312844-13.patch, failed testing.

#22

Posted by kathyh on November 2, 2011 at 5:11am
Status:needs work» needs review

Re-rolled for D8 core dir change - 11/1/11

AttachmentSizeStatusTest resultOperations
doc-hook_schema-autoloaded-1312844-22.patch732 bytesIdlePASSED: [[SimpleTest]]: [MySQL] 33,765 pass(es).View details

#23

Posted by sven.lauer on November 2, 2011 at 7:44am
Status:needs review» reviewed & tested by the community

Looks good, thanks for fixing (and re-rolling the fix for) my oversight!

This will need a re-re-roll for D7 once committed.

#24

Posted by catch on November 2, 2011 at 8:28am
Version:8.x-dev» 7.x-dev

Committed/pushed to 8.x, thanks! Moving to 7.x.

#25

Posted by sven.lauer on November 3, 2011 at 7:24am

#13: doc-hook_schema-autoloaded-1312844-13.patch queued for re-testing.

#26

Posted by jhodgdon on November 3, 2011 at 2:50pm
Issue tags:+Quick fix

Thanks, looks like #13 is good for D7. Not very controversial to apply it. :)

#27

Posted by webchick on November 4, 2011 at 4:18am
Status:reviewed & tested by the community» fixed

Committed and pushed to 7.x. Thanks!

#28

Posted by System Message on November 18, 2011 at 4:20am
Status:fixed» closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.

nobody click here