Code

Opened 6 years ago

Closed 6 years ago

#6551 closed (fixed)

improve Database setup section on tutorial

Reported by: hvelarde Owned by: nobody
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

I'm using Windows and SQLite and for me it was quite confusing to read: "DATABASE_NAME — The name of your database, or the full (absolute) path to the database file if you’re using SQLite".

first, I was using a path name only, without the file name (c:\temp).

then I was using backslashes (c:\temp\temp.sql) instead of slashes (c:/temp/temp.sql).

it would be great if you can clarify this on that section.

thanks!

Attachments (0)

Change History (4)

comment:1 Changed 6 years ago by tonyskyday

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

Perhaps adding "(including file name)" to the comment would make it slightly more clear:

# Or path to database file (including file name) if using sqlite3.

However, this still leaves room for confusion by those that are unfamiliar with sqlite3 and it doesn't add any useful information for those who know how to use sqlite3.

comment:2 Changed 6 years ago by derek.ditch@…

On a similar note, I've worked with some Windows developers that didn't notice the specific need for a filename here. Lack of a filename (empty string) still allows syncdb to run without error. The only problem is, subsequent calls to try to access the models throws an exception since the tables do not exist. There should be a check to validate that a valid filename or :memory: is given, although the latter doesn't seem to provide much usefulness

comment:3 Changed 6 years ago by guettli

  • Triage Stage changed from Unreviewed to Accepted

comment:4 Changed 6 years ago by ubernostrum

  • Resolution set to fixed
  • Status changed from new to closed

(In [8374]) Fixed #6551: clarify the meaning of DATABASE_NAME for SQLite in docs/tutorial01.txt

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.