Class: Ansible::Ruby::Modules::Django_manage

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/web_infrastructure/django_manage.rb

Overview

Manages a Django application using the I(manage.py) application frontend to I(django-admin). With the I(virtualenv) parameter, all management commands will be executed by the given I(virtualenv) installation.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#app_path ⇒ String

Returns The path to the root of the Django application where B(manage.py) lives.

Returns:

  • (String) —

    The path to the root of the Django application where B(manage.py) lives.



16
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/django_manage.rb', line 16

attribute :app_path

#apps ⇒ String?

Returns A list of space-delimited apps to target. Used by the ‘test’ command.

Returns:

  • (String, nil) —

    A list of space-delimited apps to target. Used by the ‘test’ command.



32
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/django_manage.rb', line 32

attribute :apps

#cache_table ⇒ Object?

Returns The name of the table used for database-backed caching. Used by the ‘createcachetable’ command.

Returns:

  • (Object, nil) —

    The name of the table used for database-backed caching. Used by the ‘createcachetable’ command.



36
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/django_manage.rb', line 36

attribute :cache_table

#clear ⇒ Symbol?

Returns Clear the existing files before trying to copy or link the original file.,Used only with the ‘collectstatic’ command. The C(–noinput) argument will be added automatically.

Returns:

  • (Symbol, nil) —

    Clear the existing files before trying to copy or link the original file.,Used only with the ‘collectstatic’ command. The C(–noinput) argument will be added automatically.



39
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/django_manage.rb', line 39

attribute :clear

#command ⇒ :cleanup, ...

Returns The name of the Django management command to run. Built in commands are cleanup, collectstatic, flush, loaddata, migrate, runfcgi, syncdb, test, and validate.,Other commands can be entered, but will fail if they’re unknown to Django. Other commands that may prompt for user input should be run with the I(–noinput) flag.

Returns:

  • (:cleanup, :collectstatic, :flush, :loaddata, :migrate, :runfcgi, :syncdb, :test, :validate) —

    The name of the Django management command to run. Built in commands are cleanup, collectstatic, flush, loaddata, migrate, runfcgi, syncdb, test, and validate.,Other commands can be entered, but will fail if they’re unknown to Django. Other commands that may prompt for user input should be run with the I(–noinput) flag.



12
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/django_manage.rb', line 12

attribute :command

#database ⇒ Object?

Returns The database to target. Used by the ‘createcachetable’, ‘flush’, ‘loaddata’, and ‘syncdb’ commands.

Returns:

  • (Object, nil) —

    The database to target. Used by the ‘createcachetable’, ‘flush’, ‘loaddata’, and ‘syncdb’ commands.



43
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/django_manage.rb', line 43

attribute :database

#failfast ⇒ :yes, ...

Returns Fail the command immediately if a test fails. Used by the ‘test’ command.

Returns:

  • (:yes, :no, nil) —

    Fail the command immediately if a test fails. Used by the ‘test’ command.



46
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/django_manage.rb', line 46

attribute :failfast

#fixtures ⇒ String?

Returns A space-delimited list of fixture file names to load in the database. B(Required) by the ‘loaddata’ command.

Returns:

  • (String, nil) —

    A space-delimited list of fixture file names to load in the database. B(Required) by the ‘loaddata’ command.



50
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/django_manage.rb', line 50

attribute :fixtures

#link ⇒ Object?

Returns Will create links to the files instead of copying them, you can only use this parameter with ‘collectstatic’ command.

Returns:

  • (Object, nil) —

    Will create links to the files instead of copying them, you can only use this parameter with ‘collectstatic’ command



60
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/django_manage.rb', line 60

attribute :link

#merge ⇒ Object?

Returns Will run out-of-order or missing migrations as they are not rollback migrations, you can only use this parameter with ‘migrate’ command.

Returns:

  • (Object, nil) —

    Will run out-of-order or missing migrations as they are not rollback migrations, you can only use this parameter with ‘migrate’ command



57
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/django_manage.rb', line 57

attribute :merge

#pythonpath ⇒ String?

Returns A directory to add to the Python path. Typically used to include the settings module if it is located external to the application directory.

Returns:

  • (String, nil) —

    A directory to add to the Python path. Typically used to include the settings module if it is located external to the application directory.



24
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/django_manage.rb', line 24

attribute :pythonpath

#settings ⇒ String?

Returns The Python path to the application’s settings module, such as ‘myapp.settings’.

Returns:

  • (String, nil) —

    The Python path to the application’s settings module, such as ‘myapp.settings’.



20
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/django_manage.rb', line 20

attribute :settings

#skip ⇒ Object?

Returns Will skip over out-of-order missing migrations, you can only use this parameter with I(migrate).

Returns:

  • (Object, nil) —

    Will skip over out-of-order missing migrations, you can only use this parameter with I(migrate)



54
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/django_manage.rb', line 54

attribute :skip

#virtualenv ⇒ String?

Returns An optional path to a I(virtualenv) installation to use while running the manage application.

Returns:

  • (String, nil) —

    An optional path to a I(virtualenv) installation to use while running the manage application.



28
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/django_manage.rb', line 28

attribute :virtualenv