What are the primary benefits of using NCache Compact Serialization?

Compact Serialization significantly reduces serialized object size compared to standard .NET serialization by using type IDs instead of long type names, which lowers memory usage and improves network throughput.

When should I use the -NonCompactAttributes parameter?

Use -NonCompactAttributes to exclude specific fields that do not benefit from compaction, such as very large strings, complex collections, or transient fields. You can specify multiple attributes using the '$' delimiter (e.g., 'Field1$Field2').

Do I need to stop the cache before registering new compact types?

Yes. Adding compact types modifies the permanent cache configuration. Stopping the cache via 'Stop-Cache' before running the cmdlet ensures that the new metadata is correctly synchronized across all cluster nodes upon the next 'Start-Cache' operation.

Add-CompactType [Deprecated]

This PowerShell cmdlet enables users to register a custom .NET class for compact serialization on the specified NCache caches. It allows configuring a class with selected attributes marked as non-compact while the remaining attributes are compact serialized, helping reduce object size, improve serialization performance, and optimize cache memory usage.

Add-CompactType -AssemblyPath -CacheName -Class [-NonCompactAttributes] [-Port] [-Server] [-Credentials] [-NoLogo]

Examples

This command configures the object class Customer as compact serializable for a cache named demoCache.

Add-CompactType -CacheName demoCache -AssemblyPath C:\Data.dll -Class Data.Customer

This command configures the object class Customer as compact serializable for a cache named demoCache and marks the attributes CustomerID and FirstName as non-compact.

Add-CompactType -CacheName demoCache -AssemblyPath C:\Data.dll -Class Data.Customer -NonCompactAttributes "CustomerID'$'FirstName"

This command configures the object class Customer as compact serializable for a cache named demoCache and marks the attributes CustomerID and FirstName as non-compact on the server node 20.200.20.11.

Add-CompactType -CacheName demoCache -AssemblyPath C:\Data.dll -Class Data.Customer -NonCompactAttributes "CustomerID'$'FirstName" -Server 20.200.20.11

This command configures the object class Customer as compact serializable for a cache named demoCache, using the provided security credentials for authentication.

Add-CompactType -CacheName demoCache -AssemblyPath C:\Data.dll -Class Data.Customer -Credentials (Get-Credential john_smith)

Properties

Note

The parameters with asterisk (*) on their names are the required parameters and the rest are optional.

Parameters	Data Types	Description	Default Value
`-AssemblyPath*`	`<String>`	Specifies the path of the assembly which needs to be configured as a compact type.	-
`-CacheName*`	`<String>`	Specifies the name of the cache. Note: The cache must already exist on the source	-
`-Class*`	`<String>`	Specifies the class which needs to be serialized.	-
`-NonCompactAttributes`	`<String>`	Specifies the attributes of the class which don't need to be serialized with a delimiter ‘$’.	-
`-Server`	`<String>`	Specifies the server name where the NCache Service is running and a cache with the specified cache-name is registered.	IP of local machine
`-Port`	`<Integer>`	Specifies the server port where the NCache Service is listening.	8250
`-Credentials`	`<pscredential>`	Specifies the user credentials required to authorize access for the specified operation. These credentials should belong to a user who has appropriate permissions at the node.	-
`-NoLogo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False

Add-CompactType [Deprecated]

Examples

Properties

Note

Contact Us