Code:
/ 4.0 / 4.0 / DEVDIV_TFS / Dev10 / Releases / RTMRel / ndp / fx / src / DataEntity / System / Data / Common / EntitySql / CqlQuery.cs / 1305376 / CqlQuery.cs
//----------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//
// @owner [....]
// @backupOwner [....]
//---------------------------------------------------------------------
namespace System.Data.Common.EntitySql
{
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Text;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Data.Metadata.Edm;
using System.Data.Common.CommandTrees;
///
/// Provides eSQL text Parsing and Compilation services.
///
///
/// This class exposes services that perform syntactic and semantic analysis of eSQL commands.
/// The syntactic validation ensures the given command conforms to eSQL formal grammar. The semantic analysis will
/// perform (list not exhaustive): type resolution and validation, ensure semantic and scoping rules, etc.
/// The services exposed by this class are:
///
/// - Translation from eSQL text commands to valid
/// - Translation from eSQL text commands to valid
///
/// Queries can be formulated in O-Space, C-Space and S-Space and the services exposed by this class are agnostic of the especific typespace or
/// metadata instance passed as required parameter in the semantic analysis by the perspective parameter. It is assumed that the perspective and
/// metadata was properly initialized.
/// Provided that the command is syntacticaly correct and meaningful within the given typespace, the result will be a valid
///
///
internal static class CqlQuery
{
///
/// Compiles an eSQL command producing a validated
/// eSQL command text
/// perspective
/// parser optionsThe command tree produced by parsing the given command.
/// Thrown when Syntatic or Semantic rules are violated and the query cannot be accepted
/// Thrown when metadata related service requests fail
/// Thrown when mapping related service requests fail
///
/// This method is not thread safe.
///
/// parameters)
{
DbCommandTree commandTreeResult = CompileCommon(commandText,
perspective,
parserOptions,
(astCommand, validatedParserOptions) =>
{
DbCommandTree commandTree = AnalyzeCommandSemantics(astCommand,
perspective,
validatedParserOptions,
parameters);
TypeHelpers.AssertEdmType(commandTree);
Debug.Assert(commandTree != null, "commandTree != null post-condition FAILED");
return commandTree;
});
return commandTreeResult;
}
///
/// Compiles an eSQL query command producing a validated
/// eSQL query command text
/// perspective
/// parser optionsThe query expression tree produced by parsing the given query command.
/// Thrown when Syntatic or Semantic rules are violated and the query expression cannot be accepted
/// Thrown when metadata related service requests fail
/// Thrown when mapping related service requests fail
///
/// This method is not thread safe.
///
/// parameters,
IEnumerable variables)
{
return CompileCommon(queryCommandText, perspective, parserOptions, (astCommand, validatedParserOptions) =>
{
DbLambda lambda = AnalyzeQueryExpressionSemantics(astCommand,
perspective,
validatedParserOptions,
parameters,
variables);
TypeHelpers.AssertEdmType(lambda.Body.ResultType);
Debug.Assert(lambda != null, "lambda != null post-condition FAILED");
return lambda;
});
}
#region Private
///
/// Parse eSQL command string into an AST
///
/// eSQL command
/// parser optionsAst
/// Thrown when Syntatic or Semantic rules are violated and the query cannot be accepted
///
/// This method is not thread safe.
///
/// ");
#endregion
AST.Node astExpr = null;
try
{
#region BID TRACING
//
// trace arguments
//
if (EntityBid.TraceOn)
{
EntityBid.Trace(" parserOptions.ParserCompilationMode=%d{System.Data.Common.ParserOptions.CompilationMode}\n", (int)parserOptions.ParserCompilationMode);
EntityBid.Trace(" commandText BEGIN\n");
EntityBid.PutStr(commandText);
EntityBid.Trace(" commandText END\n");
}
#endregion
//
// commandText and parserOptions are validated inside of CqlParser
//
//
// Create Parser
//
CqlParser cqlParser = new CqlParser(parserOptions, true);
//
// Invoke parser
//
astExpr = cqlParser.Parse(commandText);
#region BID TRACING
//
// trace result
//
if (EntityBid.TraceOn)
{
EntityBid.Trace(" astExpr=%d#\n", (null != astExpr) ? astExpr.GetHashCode() : 0);
}
#endregion
}
finally
{
#region BID TRACING
//
// leave bid scope
//
EntityBid.ScopeLeave(ref bidCookie);
#endregion
}
if (null == astExpr)
{
throw EntityUtil.EntitySqlError(commandText, System.Data.Entity.Strings.InvalidEmptyQuery, 0);
}
return astExpr;
}
private static TResult CompileCommon(string commandText,
Perspective perspective,
ParserOptions parserOptions,
Func compilationFunction)
where TResult : class
{
#region BID TRACING
//
// enter bid scope
//
IntPtr bidCookie = IntPtr.Zero;
EntityBid.ScopeEnter(out bidCookie, "");
#endregion
TResult result = null;
try
{
//
// Validate arguments
//
EntityUtil.CheckArgumentNull(perspective, "commandText");
EntityUtil.CheckArgumentNull(perspective, "perspective");
#region BID TRACING
//
// trace TargetDataspace
//
EntityBid.Trace(" perspective.TargetDataspace: %d{DataSpace}\n", (int)perspective.TargetDataspace);
#endregion
//
// Validate parser options - if null, give default options
//
parserOptions = parserOptions ?? new ParserOptions();
//
// Invoke Parser
//
AST.Node astCommand = Parse(commandText, parserOptions);
//
// Perform Semantic Analysis/Conversion
//
result = compilationFunction(astCommand, parserOptions);
}
finally
{
#region BID TRACING
//
// leave bid scope
//
EntityBid.ScopeLeave(ref bidCookie);
#endregion
}
return result;
}
///
/// Performs semantic conversion, validation on a command AST and creates a
/// Abstract Syntax Tree of the command
/// perspective
/// parser optionsa valid command tree
/// Parameters name/types must be bound before invoking this method
/// Thrown when Syntatic or Semantic rules are violated and the query cannot be accepted.
/// Thrown as inner exception of a EntityException when metadata related service requests fail.
/// Thrown as inner exception of a EntityException when mapping related service requests fail.
///
/// This method is not thread safe.
///
/// parameters)
{
DbCommandTree resultCommandTree = AnalyzeSemanticsCommon(astExpr,
perspective,
parserOptions,
parameters,
null/*variables*/,
(analyzer, astExpression) =>
{
DbCommandTree commandTree = analyzer.AnalyzeCommand(astExpression);
#region BID TRACING
//
// trace result
//
if (EntityBid.TraceOn && null != commandTree)
{
EntityBid.Trace(" DbCommandTree DUMP BEGIN\n");
commandTree.Trace();
EntityBid.Trace(" DbCommandTree DUMP END\n");
}
#endregion
Debug.Assert(commandTree != null, "commandTree != null post-condition FAILED");
return commandTree;
});
return resultCommandTree;
}
///
/// Performs semantic conversion, validation on a query command AST and creates a
/// Abstract Syntax Tree of the query command
/// perspective
/// parser optionsParameters name/types must be bound before invoking this method
/// Thrown when Syntatic or Semantic rules are violated and the query cannot be accepted.
/// Thrown as inner exception of a EntityException when metadata related service requests fail.
/// Thrown as inner exception of a EntityException when mapping related service requests fail.
///
/// This method is not thread safe.
///
/// parameters,
IEnumerable variables)
{
return AnalyzeSemanticsCommon(
astQueryCommand,
perspective,
parserOptions,
parameters,
variables,
(analyzer, astExpr) =>
{
DbLambda lambda = analyzer.AnalyzeQueryCommand(astExpr);
Debug.Assert(null != lambda, "null != lambda post-condition FAILED");
return lambda;
});
}
private static TResult AnalyzeSemanticsCommon(AST.Node astExpr,
Perspective perspective,
ParserOptions parserOptions,
IEnumerable parameters,
IEnumerable variables,
Func analysisFunction)
where TResult : class
{
#region BID TRACING
//
// enter bid scope
//
IntPtr bidCookie = IntPtr.Zero;
EntityBid.ScopeEnter(out bidCookie, "");
#endregion
TResult result = null;
try
{
//
// Validate arguments
//
EntityUtil.CheckArgumentNull(astExpr, "astExpr");
EntityUtil.CheckArgumentNull(perspective, "perspective");
#region BID TRACING
//
// trace arguments
//
if (EntityBid.TraceOn)
{
EntityBid.Trace(" astExpr=%d#\n", astExpr.GetHashCode());
EntityBid.Trace(" perspective=%d, perspective Type='%ls'\n", perspective.GetHashCode(), perspective.GetType().Name);
if (null != parserOptions)
EntityBid.Trace(" parserOptions.ParserCompilationMode=%d{System.Data.Common.ParserOptions.CompilationMode}\n", (int)parserOptions.ParserCompilationMode);
else
EntityBid.Trace(" parserOptions is NULL\n");
if (null != parameters)
foreach (DbParameterReferenceExpression param in parameters)
EntityBid.Trace(" parameter='%ls', Type='%ls'\n", param.ParameterName, param.ResultType.EdmType.Name);
else
EntityBid.Trace(" parameters=null\n");
if (null != variables)
foreach (DbVariableReferenceExpression var in variables)
EntityBid.Trace(" variable='%ls', Type='%ls'\n", var.VariableName, var.ResultType.EdmType.Name);
else
EntityBid.Trace(" variables=null\n");
}
#endregion
//
// Invoke semantic analysis
//
SemanticAnalyzer analyzer = (new SemanticAnalyzer(SemanticResolver.Create(perspective, parserOptions, parameters, variables)));
result = analysisFunction(analyzer, astExpr);
}
//
// Wrap MetadataException as EntityException inner exception
//
catch (System.Data.MetadataException metadataException)
{
throw EntityUtil.EntitySqlError(System.Data.Entity.Strings.GeneralExceptionAsQueryInnerException("Metadata"), metadataException);
}
//
// Wrap MappingException as EntityException inner exception
//
catch (System.Data.MappingException mappingException)
{
throw EntityUtil.EntitySqlError(System.Data.Entity.Strings.GeneralExceptionAsQueryInnerException("Mapping"), mappingException);
}
finally
{
#region BID TRACING
//
// leave Bid scope
//
EntityBid.ScopeLeave(ref bidCookie);
#endregion
}
return result;
}
#endregion
}
}
// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
//----------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//
// @owner [....]
// @backupOwner [....]
//---------------------------------------------------------------------
namespace System.Data.Common.EntitySql
{
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Text;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Data.Metadata.Edm;
using System.Data.Common.CommandTrees;
///
/// Provides eSQL text Parsing and Compilation services.
///
///
/// This class exposes services that perform syntactic and semantic analysis of eSQL commands.
/// The syntactic validation ensures the given command conforms to eSQL formal grammar. The semantic analysis will
/// perform (list not exhaustive): type resolution and validation, ensure semantic and scoping rules, etc.
/// The services exposed by this class are:
///
/// - Translation from eSQL text commands to valid
/// - Translation from eSQL text commands to valid
///
/// Queries can be formulated in O-Space, C-Space and S-Space and the services exposed by this class are agnostic of the especific typespace or
/// metadata instance passed as required parameter in the semantic analysis by the perspective parameter. It is assumed that the perspective and
/// metadata was properly initialized.
/// Provided that the command is syntacticaly correct and meaningful within the given typespace, the result will be a valid
///
///
internal static class CqlQuery
{
///
/// Compiles an eSQL command producing a validated
/// eSQL command text
/// perspective
/// parser optionsThe command tree produced by parsing the given command.
/// Thrown when Syntatic or Semantic rules are violated and the query cannot be accepted
/// Thrown when metadata related service requests fail
/// Thrown when mapping related service requests fail
///
/// This method is not thread safe.
///
/// parameters)
{
DbCommandTree commandTreeResult = CompileCommon(commandText,
perspective,
parserOptions,
(astCommand, validatedParserOptions) =>
{
DbCommandTree commandTree = AnalyzeCommandSemantics(astCommand,
perspective,
validatedParserOptions,
parameters);
TypeHelpers.AssertEdmType(commandTree);
Debug.Assert(commandTree != null, "commandTree != null post-condition FAILED");
return commandTree;
});
return commandTreeResult;
}
///
/// Compiles an eSQL query command producing a validated
/// eSQL query command text
/// perspective
/// parser optionsThe query expression tree produced by parsing the given query command.
/// Thrown when Syntatic or Semantic rules are violated and the query expression cannot be accepted
/// Thrown when metadata related service requests fail
/// Thrown when mapping related service requests fail
///
/// This method is not thread safe.
///
/// parameters,
IEnumerable variables)
{
return CompileCommon(queryCommandText, perspective, parserOptions, (astCommand, validatedParserOptions) =>
{
DbLambda lambda = AnalyzeQueryExpressionSemantics(astCommand,
perspective,
validatedParserOptions,
parameters,
variables);
TypeHelpers.AssertEdmType(lambda.Body.ResultType);
Debug.Assert(lambda != null, "lambda != null post-condition FAILED");
return lambda;
});
}
#region Private
///
/// Parse eSQL command string into an AST
///
/// eSQL command
/// parser optionsAst
/// Thrown when Syntatic or Semantic rules are violated and the query cannot be accepted
///
/// This method is not thread safe.
///
/// ");
#endregion
AST.Node astExpr = null;
try
{
#region BID TRACING
//
// trace arguments
//
if (EntityBid.TraceOn)
{
EntityBid.Trace(" parserOptions.ParserCompilationMode=%d{System.Data.Common.ParserOptions.CompilationMode}\n", (int)parserOptions.ParserCompilationMode);
EntityBid.Trace(" commandText BEGIN\n");
EntityBid.PutStr(commandText);
EntityBid.Trace(" commandText END\n");
}
#endregion
//
// commandText and parserOptions are validated inside of CqlParser
//
//
// Create Parser
//
CqlParser cqlParser = new CqlParser(parserOptions, true);
//
// Invoke parser
//
astExpr = cqlParser.Parse(commandText);
#region BID TRACING
//
// trace result
//
if (EntityBid.TraceOn)
{
EntityBid.Trace(" astExpr=%d#\n", (null != astExpr) ? astExpr.GetHashCode() : 0);
}
#endregion
}
finally
{
#region BID TRACING
//
// leave bid scope
//
EntityBid.ScopeLeave(ref bidCookie);
#endregion
}
if (null == astExpr)
{
throw EntityUtil.EntitySqlError(commandText, System.Data.Entity.Strings.InvalidEmptyQuery, 0);
}
return astExpr;
}
private static TResult CompileCommon(string commandText,
Perspective perspective,
ParserOptions parserOptions,
Func compilationFunction)
where TResult : class
{
#region BID TRACING
//
// enter bid scope
//
IntPtr bidCookie = IntPtr.Zero;
EntityBid.ScopeEnter(out bidCookie, "");
#endregion
TResult result = null;
try
{
//
// Validate arguments
//
EntityUtil.CheckArgumentNull(perspective, "commandText");
EntityUtil.CheckArgumentNull(perspective, "perspective");
#region BID TRACING
//
// trace TargetDataspace
//
EntityBid.Trace(" perspective.TargetDataspace: %d{DataSpace}\n", (int)perspective.TargetDataspace);
#endregion
//
// Validate parser options - if null, give default options
//
parserOptions = parserOptions ?? new ParserOptions();
//
// Invoke Parser
//
AST.Node astCommand = Parse(commandText, parserOptions);
//
// Perform Semantic Analysis/Conversion
//
result = compilationFunction(astCommand, parserOptions);
}
finally
{
#region BID TRACING
//
// leave bid scope
//
EntityBid.ScopeLeave(ref bidCookie);
#endregion
}
return result;
}
///
/// Performs semantic conversion, validation on a command AST and creates a
/// Abstract Syntax Tree of the command
/// perspective
/// parser optionsa valid command tree
/// Parameters name/types must be bound before invoking this method
/// Thrown when Syntatic or Semantic rules are violated and the query cannot be accepted.
/// Thrown as inner exception of a EntityException when metadata related service requests fail.
/// Thrown as inner exception of a EntityException when mapping related service requests fail.
///
/// This method is not thread safe.
///
/// parameters)
{
DbCommandTree resultCommandTree = AnalyzeSemanticsCommon(astExpr,
perspective,
parserOptions,
parameters,
null/*variables*/,
(analyzer, astExpression) =>
{
DbCommandTree commandTree = analyzer.AnalyzeCommand(astExpression);
#region BID TRACING
//
// trace result
//
if (EntityBid.TraceOn && null != commandTree)
{
EntityBid.Trace(" DbCommandTree DUMP BEGIN\n");
commandTree.Trace();
EntityBid.Trace(" DbCommandTree DUMP END\n");
}
#endregion
Debug.Assert(commandTree != null, "commandTree != null post-condition FAILED");
return commandTree;
});
return resultCommandTree;
}
///
/// Performs semantic conversion, validation on a query command AST and creates a
/// Abstract Syntax Tree of the query command
/// perspective
/// parser optionsParameters name/types must be bound before invoking this method
/// Thrown when Syntatic or Semantic rules are violated and the query cannot be accepted.
/// Thrown as inner exception of a EntityException when metadata related service requests fail.
/// Thrown as inner exception of a EntityException when mapping related service requests fail.
///
/// This method is not thread safe.
///
/// parameters,
IEnumerable variables)
{
return AnalyzeSemanticsCommon(
astQueryCommand,
perspective,
parserOptions,
parameters,
variables,
(analyzer, astExpr) =>
{
DbLambda lambda = analyzer.AnalyzeQueryCommand(astExpr);
Debug.Assert(null != lambda, "null != lambda post-condition FAILED");
return lambda;
});
}
private static TResult AnalyzeSemanticsCommon(AST.Node astExpr,
Perspective perspective,
ParserOptions parserOptions,
IEnumerable parameters,
IEnumerable variables,
Func analysisFunction)
where TResult : class
{
#region BID TRACING
//
// enter bid scope
//
IntPtr bidCookie = IntPtr.Zero;
EntityBid.ScopeEnter(out bidCookie, "");
#endregion
TResult result = null;
try
{
//
// Validate arguments
//
EntityUtil.CheckArgumentNull(astExpr, "astExpr");
EntityUtil.CheckArgumentNull(perspective, "perspective");
#region BID TRACING
//
// trace arguments
//
if (EntityBid.TraceOn)
{
EntityBid.Trace(" astExpr=%d#\n", astExpr.GetHashCode());
EntityBid.Trace(" perspective=%d, perspective Type='%ls'\n", perspective.GetHashCode(), perspective.GetType().Name);
if (null != parserOptions)
EntityBid.Trace(" parserOptions.ParserCompilationMode=%d{System.Data.Common.ParserOptions.CompilationMode}\n", (int)parserOptions.ParserCompilationMode);
else
EntityBid.Trace(" parserOptions is NULL\n");
if (null != parameters)
foreach (DbParameterReferenceExpression param in parameters)
EntityBid.Trace(" parameter='%ls', Type='%ls'\n", param.ParameterName, param.ResultType.EdmType.Name);
else
EntityBid.Trace(" parameters=null\n");
if (null != variables)
foreach (DbVariableReferenceExpression var in variables)
EntityBid.Trace(" variable='%ls', Type='%ls'\n", var.VariableName, var.ResultType.EdmType.Name);
else
EntityBid.Trace(" variables=null\n");
}
#endregion
//
// Invoke semantic analysis
//
SemanticAnalyzer analyzer = (new SemanticAnalyzer(SemanticResolver.Create(perspective, parserOptions, parameters, variables)));
result = analysisFunction(analyzer, astExpr);
}
//
// Wrap MetadataException as EntityException inner exception
//
catch (System.Data.MetadataException metadataException)
{
throw EntityUtil.EntitySqlError(System.Data.Entity.Strings.GeneralExceptionAsQueryInnerException("Metadata"), metadataException);
}
//
// Wrap MappingException as EntityException inner exception
//
catch (System.Data.MappingException mappingException)
{
throw EntityUtil.EntitySqlError(System.Data.Entity.Strings.GeneralExceptionAsQueryInnerException("Mapping"), mappingException);
}
finally
{
#region BID TRACING
//
// leave Bid scope
//
EntityBid.ScopeLeave(ref bidCookie);
#endregion
}
return result;
}
#endregion
}
}
// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
Link Menu
This book is available now!
Buy at Amazon US or
Buy at Amazon UK
- EpmCustomContentWriterNodeData.cs
- FixedSOMImage.cs
- CollectionEditor.cs
- WindowsClaimSet.cs
- GroupByExpressionRewriter.cs
- RegularExpressionValidator.cs
- ReadOnlyDictionary.cs
- TypeReference.cs
- pingexception.cs
- TextElementEnumerator.cs
- NullReferenceException.cs
- TagPrefixAttribute.cs
- PropertyMapper.cs
- Viewport3DAutomationPeer.cs
- BitVector32.cs
- ImmComposition.cs
- InstanceDataCollection.cs
- ECDsa.cs
- XmlHierarchicalEnumerable.cs
- AuthorizationSection.cs
- TextTreeInsertUndoUnit.cs
- FloatMinMaxAggregationOperator.cs
- SystemIPv6InterfaceProperties.cs
- MessageParameterAttribute.cs
- PersistenceTypeAttribute.cs
- CookielessHelper.cs
- ServicePointManager.cs
- KeyEventArgs.cs
- ModifyActivitiesPropertyDescriptor.cs
- CorrelationService.cs
- SimpleHandlerBuildProvider.cs
- Invariant.cs
- VoiceInfo.cs
- WebConfigurationFileMap.cs
- Base64Encoding.cs
- Int32EqualityComparer.cs
- IncrementalCompileAnalyzer.cs
- PageRanges.cs
- DataBoundControlHelper.cs
- RadioButton.cs
- Size.cs
- ReadWriteSpinLock.cs
- CodeAttributeDeclarationCollection.cs
- XmlStringTable.cs
- SecurityUtils.cs
- ImageKeyConverter.cs
- DWriteFactory.cs
- ApplicationDirectoryMembershipCondition.cs
- QueuePathDialog.cs
- TextTreeRootTextBlock.cs
- SqlMetaData.cs
- SatelliteContractVersionAttribute.cs
- Vector.cs
- LOSFormatter.cs
- ScriptingRoleServiceSection.cs
- FaultDescriptionCollection.cs
- Query.cs
- LinqDataSourceSelectEventArgs.cs
- GlobalEventManager.cs
- SimpleLine.cs
- DataException.cs
- XPathDocumentBuilder.cs
- StateMachineSubscription.cs
- BamlLocalizableResourceKey.cs
- IfJoinedCondition.cs
- XsdDateTime.cs
- ASCIIEncoding.cs
- Matrix3DValueSerializer.cs
- Util.cs
- Module.cs
- DesignerActionListCollection.cs
- ControllableStoryboardAction.cs
- BidPrivateBase.cs
- RuleSettingsCollection.cs
- SubqueryRules.cs
- ControlAdapter.cs
- QualifiedCellIdBoolean.cs
- InstanceCompleteException.cs
- XmlNamedNodeMap.cs
- HttpListenerElement.cs
- TextBoxBase.cs
- WaitHandleCannotBeOpenedException.cs
- DictionaryEntry.cs
- PrintPreviewControl.cs
- MenuAdapter.cs
- ToolStripActionList.cs
- Marshal.cs
- DuplicateContext.cs
- XmlSchemaParticle.cs
- ErrorHandlerFaultInfo.cs
- FtpWebRequest.cs
- ColumnMapTranslator.cs
- CodePageUtils.cs
- EdmError.cs
- _ScatterGatherBuffers.cs
- EventsTab.cs
- SmtpNegotiateAuthenticationModule.cs
- TextOptions.cs
- WebResourceUtil.cs
- DesignerValidatorAdapter.cs