Changes between Version 10 and Version 11 of TracDev/ApiChanges/1.1.4

Timestamp:

Mar 1, 2015, 5:46:45 AM (9 years ago)

Author:

Ryan J Ollos

Comment:

Merged changes from TracDev/ApiChanges/1.1.2.

TracDev/ApiChanges/1.1.4

@@ -150 +150 @@
 Methods have been added to `DatabaseManager` class for settings and retrieving the database version for Trac and plugins: `set_database_version` and `get_database_version` (#11859).
 
+==== `Environment.get_db_cnx` has been removed #get_db_cnx
+
+Following the [../0.12#get_db_cnx deprecation] made in 0.12, the method `Environment.get_db_cnx` has been removed.
+
+One should now only use the //context managers// for retrieving a database Connection
+in read or write mode.
+ - a **read-only** Connection can be used to form queries:
+   {{{#!python
+   with env.db_query as db:
+       ...
+   }}}
+   a `db` instance obtained the above way should only be used for executing //SELECT//
+   queries 
+ - a **writable** Connection can be used to modify the database content in a transaction:
+   {{{#!python
+   with env.db_transaction as db:
+       ...
+   }}}
+   a `db` instance obtained the above way can be used to execute //INSERT/UPDATE/DELETE//
+   queries; they will be committed when the last such automatic transaction 
+   in the control flow completes successfully. See DatabaseApi for the full details.
+
+`Environment.get_read_db` and the decorators `@with_transaction(env)` and `env.with_transaction()` have been [../1.0#with_transaction deprecated] since Trac 1.0 and will be removed in Trac 1.3.1.
+
+
+==== `db` parameters removed from function and method signatures
+
+With the introduction of `@with_transaction(env)` decorators in 0.12 and continuing with the introduction of the database connection context managers in 1.0, the `db` parameters passed as function and method arguments became [../0.12#Othernews deprecated].
+
+The `db` parameters have been removed from nearly all function and method signatures. The `db` arguments are still present on methods of `IEnvironmentParticipant` implementations, but are deprecated and should no longer be used. They will be removed in 1.3.1.
+
+
+==== `ConnectionBase` class
+
+The `ConnectionBase` class defines an abstract interface that database backends must adhere to when implementing a `Connection` class.
+
+
+=== Template and CSS changes
+
+`tt` tags are not support in HTML5 and have been replaced with `code` tags in Trac (#11094). The styling of `tt` and `code` tags is the same in Trac , but `code` tags should be used since the styling for `tt` tags will be removed in a future version of Trac.
+
+The `about.css` stylesheet has been removed and the rules contained in that stylesheet have been moved to `trac.css`. The table of environment information on the //Error// and //About// pages have been extracted to a new template `environment_info.html` and the markup and associated rules in the stylesheet have been significantly changed.
+
+//Many more changes to be added, depending on how details we want to get. TracUpgrade#CustomizedTemplates claims that changes to `id`s and CSS `class`es will be documented in ApiChanges.//
+
+
 == New in the 1.1.4 API