diff options
| author | James Bennett <ubernostrum@gmail.com> | 2008-08-31 08:55:08 +0000 |
|---|---|---|
| committer | James Bennett <ubernostrum@gmail.com> | 2008-08-31 08:55:08 +0000 |
| commit | 6ba55eee30de948f46f39afda2638f7504d63dd9 (patch) | |
| tree | c7f3744502d57a68a91371fa9a71dec502340820 /docs/ref | |
| parent | 5e26fceb83150838ab9120075aac4c346ba82917 (diff) | |
Fixed #8679: use full signature of Model.save() in docs and remove no-longer-used 'raw' argument
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8754 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/contrib/sitemaps.txt | 4 | ||||
| -rw-r--r-- | docs/ref/models/instances.txt | 34 |
2 files changed, 3 insertions, 35 deletions
diff --git a/docs/ref/contrib/sitemaps.txt b/docs/ref/contrib/sitemaps.txt index 9d7636ad6a..f8328f2f27 100644 --- a/docs/ref/contrib/sitemaps.txt +++ b/docs/ref/contrib/sitemaps.txt @@ -325,8 +325,8 @@ method:: class Entry(models.Model): # ... - def save(self): - super(Entry, self).save() + def save(self, force_insert=False, force_update=False): + super(Entry, self).save(force_insert, force_update) try: ping_google() except Exception: diff --git a/docs/ref/models/instances.txt b/docs/ref/models/instances.txt index e96a775e5f..1085e7b6df 100644 --- a/docs/ref/models/instances.txt +++ b/docs/ref/models/instances.txt @@ -33,7 +33,7 @@ To save an object back to the database, call ``save()``: .. method:: Model.save([force_insert=False, force_update=False]) -Of course, there's some subtleties; see the sections below. +Of course, there are some subtleties; see the sections below. **New in Django development version:** The signature of the ``save()`` method has changed from earlier versions (``force_insert`` and ``force_update`` have @@ -144,38 +144,6 @@ When you save an object, Django performs the following steps: is used to provide notification that an object has been successfully saved. (These signals are not yet documented.) -Raw saves -~~~~~~~~~ - -**New in Django development version** - -The pre-processing step (#2 in the previous section) is useful, but it modifies -the data stored in a field. This can cause problems if you're relying upon the -data you provide being used as-is. - -For example, if you're setting up conditions for a test, you'll want the test -conditions to be repeatable. If pre-processing is performed, the data used -to specify test conditions may be modified, changing the conditions for the -test each time the test is run. - -In cases such as this, you need to prevent pre-processing from being performed -when you save an object. To do this, you can invoke a **raw save** by passing -``raw=True`` as an argument to the ``save()`` method:: - - b4.save(raw=True) # Save object, but do no pre-processing - -A raw save skips the usual data pre-processing that is performed during the -save. All other steps in the save (pre-save signal, data preparation, data -insertion, and post-save signal) are performed as normal. - -.. admonition:: When to use a raw save - - Generally speaking, you shouldn't need to use a raw save. Disabling field - pre-processing is an extraordinary measure that should only be required - in extraordinary circumstances, such as setting up reliable test - conditions. - - How Django knows to UPDATE vs. INSERT ------------------------------------- |
