Management API Reference for table=string

Defines a table used to store cache entries whose keys can be expressed as strings.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.clustering.infinispan.cache-configuration.store.table.string	true	/subsystem=infinispan/cache-container=/replicated-cache=/store=jdbc/table=string /subsystem=infinispan/cache-container=/local-cache=/store=jdbc/table=string /subsystem=infinispan/cache-container=/invalidation-cache=/store=jdbc/table=string /subsystem=infinispan/cache-container=/distributed-cache=/store=jdbc/table=string

Attributes (8)

create-on-start - Indicates whether the store should create this database table when the cache starts.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates whether the store should create this database table when the cache starts.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

data-column - A database column to hold cache entry data.

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A database column to hold cache entry data.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the database column.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "datum", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of the database column.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "BINARY", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

drop-on-stop - Indicates whether the store should drop this database table when the cache stops.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates whether the store should drop this database table when the cache stops.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

fetch-size - For DB queries, the fetch size will be used to set the fetch size on ResultSets.

Type	INT
Default Value	100
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 100, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

id-column - A database column to hold cache entry ids.

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A database column to hold cache entry ids.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the database column.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "id", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of the database column.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "VARCHAR", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

prefix - The prefix for the database table name.

Type	STRING
Default Value	ispn_entry
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The prefix for the database table name.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "ispn_entry", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

segment-column - A database column to hold cache entry segment.

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A database column to hold cache entry segment.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the database column.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "segment", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of the database column.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "INTEGER", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

timestamp-column - A database column to hold cache entry timestamps.

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A database column to hold cache entry timestamps.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the database column.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "version", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of the database column.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "BIGINT", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

Operations (2)

add - Adds a table used to store cache entries whose keys can be expressed as strings.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
create-on-start	BOOLEAN	false	true	true	Indicates whether the store should create this database table when the cache starts.
data-column	OBJECT	false	false		A database column to hold cache entry data.
drop-on-stop	BOOLEAN	false	true	false	Indicates whether the store should drop this database table when the cache stops.
fetch-size	INT	false	true	100	For DB queries, the fetch size will be used to set the fetch size on ResultSets.
id-column	OBJECT	false	false		A database column to hold cache entry ids.
prefix	STRING	false	true	ispn_entry	The prefix for the database table name.
segment-column	OBJECT	false	false		A database column to hold cache entry segment.
timestamp-column	OBJECT	false	false		A database column to hold cache entry timestamps.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a table used to store cache entries whose keys can be expressed as strings.",
    "request-properties" : {
        "create-on-start" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Indicates whether the store should create this database table when the cache starts.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "data-column" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "A database column to hold cache entry data.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The name of the database column.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "default" : "datum",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "type" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The type of the database column.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "default" : "BINARY",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "drop-on-stop" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Indicates whether the store should drop this database table when the cache stops.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "fetch-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "For DB queries, the fetch size will be used to set the fetch size on ResultSets.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 100,
            "stability" : "default"
        },
        "id-column" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "A database column to hold cache entry ids.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The name of the database column.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "default" : "id",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "type" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The type of the database column.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "default" : "VARCHAR",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "prefix" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The prefix for the database table name.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "ispn_entry",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "segment-column" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "A database column to hold cache entry segment.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The name of the database column.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "default" : "segment",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "type" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The type of the database column.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "default" : "INTEGER",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "timestamp-column" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "A database column to hold cache entry timestamps.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The name of the database column.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "default" : "version",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "type" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The type of the database column.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "default" : "BIGINT",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes a table used to store cache entries whose keys can be expressed as strings.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a table used to store cache entries whose keys can be expressed as strings.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.infinispan.cache-container.scattered-cache.store.jdbc.table.string

        
<feature spec="subsystem.infinispan.cache-container.scattered-cache.store.jdbc.table.string">
  <param name="cache-container" value="{resource name}"/>
  <param name="scattered-cache" value="{resource name}"/>
  <param name="create-on-start" value="{value}"/>
  <param name="data-column" value="{value}"/>
  <param name="drop-on-stop" value="{value}"/>
  <param name="fetch-size" value="{value}"/>
  <param name="id-column" value="{value}"/>
  <param name="prefix" value="{value}"/>
  <param name="segment-column" value="{value}"/>
  <param name="timestamp-column" value="{value}"/>
<feature/>